Merge pull request #1537 from microsoft/fix/request-body-write

Ensure reading request body does not drain the input stream if stream is not resettable

CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.3.0] - 2024-08-22
+
+### Changed
+
+- Ensure interceptors don't drain request body stream before network call [#2037](https://github.com/microsoftgraph/msgraph-sdk-java/issues/2037)
+
 ## [1.2.0] - 2024-08-09
 
 ### Changed

README.md

@@ -21,14 +21,14 @@ Read more about Kiota [here](https://github.com/microsoft/kiota/blob/main/README
 In `build.gradle` in the `dependencies` section:
 
 ```Groovy
-implementation 'com.microsoft.kiota:microsoft-kiota-abstractions:1.2.0'
-implementation 'com.microsoft.kiota:microsoft-kiota-authentication-azure:1.2.0'
-implementation 'com.microsoft.kiota:microsoft-kiota-http-okHttp:1.2.0'
-implementation 'com.microsoft.kiota:microsoft-kiota-serialization-json:1.2.0'
-implementation 'com.microsoft.kiota:microsoft-kiota-serialization-text:1.2.0'
-implementation 'com.microsoft.kiota:microsoft-kiota-serialization-form:1.2.0'
-implementation 'com.microsoft.kiota:microsoft-kiota-serialization-multipart:1.2.0'
-implementation 'com.microsoft.kiota:microsoft-kiota-bundle:1.2.0'
+implementation 'com.microsoft.kiota:microsoft-kiota-abstractions:1.3.0'
+implementation 'com.microsoft.kiota:microsoft-kiota-authentication-azure:1.3.0'
+implementation 'com.microsoft.kiota:microsoft-kiota-http-okHttp:1.3.0'
+implementation 'com.microsoft.kiota:microsoft-kiota-serialization-json:1.3.0'
+implementation 'com.microsoft.kiota:microsoft-kiota-serialization-text:1.3.0'
+implementation 'com.microsoft.kiota:microsoft-kiota-serialization-form:1.3.0'
+implementation 'com.microsoft.kiota:microsoft-kiota-serialization-multipart:1.3.0'
+implementation 'com.microsoft.kiota:microsoft-kiota-bundle:1.3.0'
 implementation 'jakarta.annotation:jakarta.annotation-api:2.1.1'
 ```
 
@@ -40,37 +40,37 @@ In `pom.xml` in the `dependencies` section:
     <dependency>
       <groupId>com.microsoft.kiota</groupId>
       <artifactId>microsoft-kiota-abstractions</artifactId>
-      <version>1.2.0</version>
+      <version>1.3.0</version>
     </dependency>
     <dependency>
       <groupId>com.microsoft.kiota</groupId>
       <artifactId>microsoft-kiota-authentication-azure</artifactId>
-      <version>1.2.0</version>
+      <version>1.3.0</version>
     </dependency>
     <dependency>
       <groupId>com.microsoft.kiota</groupId>
       <artifactId>microsoft-kiota-http-okHttp</artifactId>
-      <version>1.2.0</version>
+      <version>1.3.0</version>
     </dependency>
     <dependency>
       <groupId>com.microsoft.kiota</groupId>
       <artifactId>microsoft-kiota-serialization-json</artifactId>
-      <version>1.2.0</version>
+      <version>1.3.0</version>
     </dependency>
     <dependency>
       <groupId>com.microsoft.kiota</groupId>
       <artifactId>microsoft-kiota-serialization-text</artifactId>
-      <version>1.2.0</version>
+      <version>1.3.0</version>
     </dependency>
     <dependency>
       <groupId>com.microsoft.kiota</groupId>
       <artifactId>microsoft-kiota-serialization-form</artifactId>
-      <version>1.2.0</version>
+      <version>1.3.0</version>
     </dependency>
     <dependency>
       <groupId>com.microsoft.kiota</groupId>
       <artifactId>microsoft-kiota-serialization-multipart</artifactId>
-      <version>1.2.0</version>
+      <version>1.3.0</version>
     </dependency>
     <dependency>
       <groupId>jakarta.annotation</groupId>

components/http/okHttp/gradle/dependencies.gradle

@@ -6,6 +6,7 @@ dependencies {
     // Use JUnit Jupiter Engine for testing.
     testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine'
     testImplementation 'org.mockito:mockito-inline:5.2.0'
+    testImplementation 'com.squareup.okhttp3:logging-interceptor:4.12.0'
 
 
     // This dependency is used internally, and not exposed to consumers on their own compile classpath.

components/http/okHttp/src/main/java/com/microsoft/kiota/http/OkHttpRequestAdapter.java

@@ -899,6 +899,11 @@ public MediaType contentType() {
                                     }
                                 }
 
+                                @Override
+                                public boolean isOneShot() {
+                                    return !requestInfo.content.markSupported();
+                                }
+
                                 @Override
                                 public long contentLength() throws IOException {
                                     final Set<String> contentLength =
@@ -923,6 +928,9 @@ public long contentLength() throws IOException {
                                 @Override
                                 public void writeTo(@Nonnull BufferedSink sink) throws IOException {
                                     sink.writeAll(Okio.source(requestInfo.content));
+                                    if (!isOneShot()) {
+                                        requestInfo.content.reset();
+                                    }
                                 }
                             };
 

components/http/okHttp/src/main/java/com/microsoft/kiota/http/middleware/options/UserAgentHandlerOption.java

@@ -13,7 +13,7 @@ public UserAgentHandlerOption() {}
 
     private boolean enabled = true;
     @Nonnull private String productName = "kiota-java";
-    @Nonnull private String productVersion = "1.2.0";
+    @Nonnull private String productVersion = "1.3.0";
 
     /**
      * Gets the product name to be used in the user agent header

components/http/okHttp/src/test/java/com/microsoft/kiota/http/OkHttpRequestAdapterTest.java

@@ -6,6 +6,7 @@
 
 import com.microsoft.kiota.ApiException;
 import com.microsoft.kiota.HttpMethod;
+import com.microsoft.kiota.NativeResponseHandler;
 import com.microsoft.kiota.RequestInformation;
 import com.microsoft.kiota.authentication.AuthenticationProvider;
 import com.microsoft.kiota.serialization.Parsable;
@@ -19,13 +20,17 @@
 import okhttp3.Call;
 import okhttp3.Callback;
 import okhttp3.Dispatcher;
+import okhttp3.Interceptor;
 import okhttp3.MediaType;
 import okhttp3.OkHttpClient;
 import okhttp3.Protocol;
 import okhttp3.Request;
 import okhttp3.Response;
 import okhttp3.ResponseBody;
+import okhttp3.logging.HttpLoggingInterceptor;
+import okhttp3.logging.HttpLoggingInterceptor.Level;
 
+import okio.Buffer;
 import okio.Okio;
 
 import org.junit.jupiter.api.Test;
@@ -401,6 +406,135 @@ void getRequestFromRequestInformationWithoutContentLengthOverrideWithEmptyPayloa
         assertEquals(0, request.body().contentLength());
     }
 
+    @Test
+    void buildsNativeRequestSupportingMultipleWrites() throws Exception {
+        final var authenticationProviderMock = mock(AuthenticationProvider.class);
+        final var requestInformation = new RequestInformation();
+        requestInformation.setUri(new URI("https://localhost"));
+        var requestBodyJson = "{\"name\":\"value\",\"array\":[\"1\",\"2\",\"3\"]}";
+        ByteArrayInputStream content =
+                new ByteArrayInputStream(requestBodyJson.getBytes(StandardCharsets.UTF_8));
+        requestInformation.setStreamContent(content, "application/json");
+        requestInformation.httpMethod = HttpMethod.PUT;
+
+        final var adapter = new OkHttpRequestAdapter(authenticationProviderMock);
+        final var request =
+                adapter.getRequestFromRequestInformation(
+                        requestInformation, mock(Span.class), mock(Span.class));
+
+        final var requestBody = request.body();
+        assertNotNull(requestBody);
+        var buffer = new Buffer();
+        requestBody.writeTo(buffer);
+        assertEquals(requestBodyJson, buffer.readUtf8());
+
+        // Second write to the buffer to ensure the body is not consumed
+        buffer = new Buffer();
+        requestBody.writeTo(buffer);
+        assertEquals(requestBodyJson, buffer.readUtf8());
+    }
+
+    @Test
+    void buildsNativeRequestSupportingOneShotWrite() throws Exception {
+        final var authenticationProviderMock = mock(AuthenticationProvider.class);
+        final var testFile = new File("./src/test/resources/helloWorld.txt");
+        final var requestInformation = new RequestInformation();
+
+        requestInformation.setUri(new URI("https://localhost"));
+        requestInformation.httpMethod = HttpMethod.PUT;
+        final var contentLength = testFile.length();
+        requestInformation.headers.add("Content-Length", String.valueOf(contentLength));
+        try (FileInputStream content = new FileInputStream(testFile)) {
+            requestInformation.setStreamContent(content, "application/octet-stream");
+
+            final var adapter = new OkHttpRequestAdapter(authenticationProviderMock);
+            final var request =
+                    adapter.getRequestFromRequestInformation(
+                            requestInformation, mock(Span.class), mock(Span.class));
+
+            final var requestBody = request.body();
+            assertNotNull(requestBody);
+            var buffer = new Buffer();
+            requestBody.writeTo(buffer);
+            assertEquals(contentLength, buffer.size());
+
+            // Second write to the buffer to ensure the body is not consumed
+            buffer = new Buffer();
+            requestBody.writeTo(buffer);
+            assertEquals(0, buffer.size());
+        }
+    }
+
+    @Test
+    void loggingInterceptorDoesNotDrainRequestBodyForMarkableStreams() throws Exception {
+        var loggingInterceptor = new HttpLoggingInterceptor();
+        loggingInterceptor.setLevel(Level.BODY);
+
+        var okHttpClient =
+                KiotaClientFactory.create()
+                        .addInterceptor(loggingInterceptor)
+                        .addInterceptor(new MockResponseHandler())
+                        .build();
+
+        final var authenticationProviderMock = mock(AuthenticationProvider.class);
+        authenticationProviderMock.authenticateRequest(
+                any(RequestInformation.class), any(Map.class));
+        var requestAdapter =
+                new OkHttpRequestAdapter(authenticationProviderMock, null, null, okHttpClient);
+
+        final var requestInformation = new RequestInformation();
+        requestInformation.setUri(new URI("https://localhost"));
+        var requestBodyJson = "{\"name\":\"value\",\"array\":[\"1\",\"2\",\"3\"]}";
+        ByteArrayInputStream content =
+                new ByteArrayInputStream(requestBodyJson.getBytes(StandardCharsets.UTF_8));
+        requestInformation.setStreamContent(content, "application/json");
+        requestInformation.httpMethod = HttpMethod.PUT;
+        var nativeResponseHandler = new NativeResponseHandler();
+        requestInformation.setResponseHandler(nativeResponseHandler);
+
+        var mockEntity = creatMockEntity();
+        requestAdapter.send(requestInformation, null, node -> mockEntity);
+        var nativeResponse = (Response) nativeResponseHandler.getValue();
+        assertNotNull(nativeResponse);
+        assertEquals(requestBodyJson, nativeResponse.body().source().readUtf8());
+    }
+
+    @Test
+    void loggingInterceptorDoesNotDrainRequestBodyForNonMarkableStreams() throws Exception {
+        var loggingInterceptor = new HttpLoggingInterceptor();
+        loggingInterceptor.setLevel(Level.BODY);
+
+        var okHttpClient =
+                KiotaClientFactory.create()
+                        .addInterceptor(loggingInterceptor)
+                        .addInterceptor(new MockResponseHandler())
+                        .build();
+
+        final var authenticationProviderMock = mock(AuthenticationProvider.class);
+        authenticationProviderMock.authenticateRequest(
+                any(RequestInformation.class), any(Map.class));
+        var requestAdapter =
+                new OkHttpRequestAdapter(authenticationProviderMock, null, null, okHttpClient);
+
+        final var requestInformation = new RequestInformation();
+        requestInformation.setUri(new URI("https://localhost"));
+        requestInformation.httpMethod = HttpMethod.PUT;
+        var nativeResponseHandler = new NativeResponseHandler();
+        requestInformation.setResponseHandler(nativeResponseHandler);
+
+        final var testFile = new File("./src/test/resources/helloWorld.txt");
+        final var contentLength = testFile.length();
+
+        try (FileInputStream content = new FileInputStream(testFile)) {
+            requestInformation.setStreamContent(content, "application/octet-stream");
+            var mockEntity = creatMockEntity();
+            requestAdapter.send(requestInformation, null, node -> mockEntity);
+            var nativeResponse = (Response) nativeResponseHandler.getValue();
+            assertNotNull(nativeResponse);
+            assertEquals(contentLength, nativeResponse.body().source().readByteArray().length);
+        }
+    }
+
     public static OkHttpClient getMockClient(final Response response) throws IOException {
         final OkHttpClient mockClient = mock(OkHttpClient.class);
         final Call remoteCall = mock(Call.class);
@@ -440,4 +574,33 @@ public ParseNodeFactory creatMockParseNodeFactory(
         when(mockFactory.getValidContentType()).thenReturn(validContentType);
         return mockFactory;
     }
+
+    // Returns request body as response body
+    static class MockResponseHandler implements Interceptor {
+        @Override
+        public Response intercept(Chain chain) throws IOException {
+            final var request = chain.request();
+            final var requestBody = request.body();
+            if (request != null && requestBody != null) {
+                final var buffer = new Buffer();
+                requestBody.writeTo(buffer);
+                return new Response.Builder()
+                        .code(200)
+                        .message("OK")
+                        .protocol(Protocol.HTTP_1_1)
+                        .request(request)
+                        .body(
+                                ResponseBody.create(
+                                        buffer.readByteArray(),
+                                        MediaType.parse("application/json")))
+                        .build();
+            }
+            return new Response.Builder()
+                    .code(200)
+                    .message("OK")
+                    .protocol(Protocol.HTTP_1_1)
+                    .request(request)
+                    .build();
+        }
+    }
 }

gradle.properties

@@ -25,7 +25,7 @@ org.gradle.caching=true
 
 mavenGroupId         = com.microsoft.kiota
 mavenMajorVersion = 1
-mavenMinorVersion = 2
+mavenMinorVersion = 3
 mavenPatchVersion = 0
 mavenArtifactSuffix =