Repository navigation
MLE-32970 Prevent retries of multipart streaming requests #1979
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
rjdew-progress
wants to merge
2
commits into
develop
Choose a base branch
from
MLE-32953
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+212
−16
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
146 changes: 146 additions & 0 deletions
146
marklogic-client-api/src/test/java/com/marklogic/client/impl/StreamingOutputImplTest.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,146 @@ | ||
| /* | ||
| * Copyright (c) 2010-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved. | ||
| */ | ||
| package com.marklogic.client.impl; | ||
|
|
||
| import com.marklogic.client.impl.okhttp.RetryIOExceptionInterceptor; | ||
| import okhttp3.MediaType; | ||
| import okhttp3.MultipartBody; | ||
| import okhttp3.OkHttpClient; | ||
| import okhttp3.Request; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| import java.io.ByteArrayInputStream; | ||
| import java.io.IOException; | ||
| import java.io.InputStream; | ||
| import java.nio.charset.StandardCharsets; | ||
| import java.util.concurrent.atomic.AtomicInteger; | ||
|
|
||
| import static org.junit.jupiter.api.Assertions.assertEquals; | ||
| import static org.junit.jupiter.api.Assertions.assertFalse; | ||
| import static org.junit.jupiter.api.Assertions.assertThrows; | ||
| import static org.junit.jupiter.api.Assertions.assertTrue; | ||
|
|
||
| class StreamingOutputImplTest { | ||
|
|
||
| @Test | ||
| void multipartBodyWithStreamingPartIsNotRetried() { | ||
| StreamingOutputImpl streamingBody = new StreamingOutputImpl( | ||
| outputStream -> outputStream.write("content".getBytes(StandardCharsets.UTF_8)), | ||
| null, | ||
| MediaType.get("application/xml") | ||
| ); | ||
| MultipartBody multipartBody = new MultipartBody.Builder() | ||
| .setType(MultipartBody.FORM) | ||
| .addFormDataPart("body", null, streamingBody) | ||
| .build(); | ||
| assertTrue(multipartBody.isOneShot()); | ||
|
|
||
| AtomicInteger attempts = new AtomicInteger(); | ||
| OkHttpClient client = new OkHttpClient.Builder() | ||
| .addInterceptor(new RetryIOExceptionInterceptor(3, 0, 1, 0)) | ||
| .addInterceptor(chain -> { | ||
| attempts.incrementAndGet(); | ||
| throw new IOException("unexpected end of stream"); | ||
| }) | ||
| .build(); | ||
| Request request = new Request.Builder() | ||
| .url("http://localhost/") | ||
| .post(multipartBody) | ||
| .build(); | ||
|
|
||
| assertThrows(IOException.class, () -> client.newCall(request).execute()); | ||
| assertEquals(1, attempts.get()); | ||
| } | ||
|
|
||
| @Test | ||
| void multipartBodyWithInputStreamPartIsNotRetried() { | ||
| InputStream inputStream = new ByteArrayInputStream("content".getBytes(StandardCharsets.UTF_8)); | ||
| OkHttpServices.ObjectRequestBody inputStreamBody = | ||
| new OkHttpServices.ObjectRequestBody(inputStream, MediaType.get("application/xml")); | ||
| MultipartBody multipartBody = new MultipartBody.Builder() | ||
| .setType(MultipartBody.FORM) | ||
| .addFormDataPart("body", null, inputStreamBody) | ||
| .build(); | ||
| assertTrue(multipartBody.isOneShot(), | ||
| "A multipart body containing an InputStream-backed part must be one-shot so the retry interceptor does " + | ||
| "not replay an already-consumed stream."); | ||
|
|
||
| AtomicInteger attempts = new AtomicInteger(); | ||
| OkHttpClient client = new OkHttpClient.Builder() | ||
| .addInterceptor(new RetryIOExceptionInterceptor(3, 0, 1, 0)) | ||
| .addInterceptor(chain -> { | ||
| attempts.incrementAndGet(); | ||
| throw new IOException("unexpected end of stream"); | ||
| }) | ||
| .build(); | ||
| Request request = new Request.Builder() | ||
| .url("http://localhost/") | ||
| .post(multipartBody) | ||
| .build(); | ||
|
|
||
| assertThrows(IOException.class, () -> client.newCall(request).execute()); | ||
| assertEquals(1, attempts.get()); | ||
| } | ||
|
|
||
| @Test | ||
| void resendableStreamingBodyIsRetried() { | ||
| StreamingOutputImpl resendableBody = new StreamingOutputImpl( | ||
| outputStream -> outputStream.write("content".getBytes(StandardCharsets.UTF_8)), | ||
| null, | ||
| MediaType.get("application/xml"), | ||
| true | ||
| ); | ||
| assertTrue(resendableBody.isRetryable(), | ||
| "A handle that reports isResendable() == true should allow its StreamingOutputImpl wrapper to be retried."); | ||
| assertFalse(resendableBody.isOneShot(), | ||
| "A resendable StreamingOutputImpl should not be marked one-shot, so OkHttp permits rewriting its body."); | ||
|
|
||
| AtomicInteger attempts = new AtomicInteger(); | ||
| OkHttpClient client = new OkHttpClient.Builder() | ||
| .addInterceptor(new RetryIOExceptionInterceptor(3, 0, 1, 0)) | ||
| .addInterceptor(chain -> { | ||
| if (attempts.incrementAndGet() < 2) { | ||
| throw new IOException("unexpected end of stream"); | ||
| } | ||
| return new okhttp3.Response.Builder() | ||
| .request(chain.request()) | ||
| .protocol(okhttp3.Protocol.HTTP_1_1) | ||
| .code(200) | ||
| .message("OK") | ||
| .body(okhttp3.ResponseBody.create("", null)) | ||
| .build(); | ||
| }) | ||
| .build(); | ||
| Request request = new Request.Builder() | ||
| .url("http://localhost/") | ||
| .post(resendableBody) | ||
| .build(); | ||
|
|
||
| try (okhttp3.Response response = client.newCall(request).execute()) { | ||
| assertEquals(200, response.code()); | ||
| } catch (IOException e) { | ||
| throw new RuntimeException(e); | ||
| } | ||
| assertEquals(2, attempts.get(), | ||
| "The request should have been retried once after the first simulated connection failure."); | ||
| } | ||
|
|
||
| @Test | ||
| void nonResendableHandleInMultipartIsNotRetried() { | ||
| // Mirrors how OkHttpServices wraps a non-resendable handle (e.g. ReaderHandle) in a Data Services multipart | ||
| // request: the per-part resendable flag should propagate up through MultipartBody.isOneShot(). | ||
| StreamingOutputImpl nonResendablePart = new StreamingOutputImpl( | ||
| outputStream -> outputStream.write("content".getBytes(StandardCharsets.UTF_8)), | ||
| null, | ||
| MediaType.get("application/xml"), | ||
| false | ||
| ); | ||
| MultipartBody multipartBody = new MultipartBody.Builder() | ||
| .setType(MultipartBody.FORM) | ||
| .addFormDataPart("body", null, nonResendablePart) | ||
| .build(); | ||
| assertTrue(multipartBody.isOneShot(), | ||
| "A multipart request containing even one non-resendable part must remain one-shot overall."); | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.