Skip to content

Commit c9817ea

Browse files
rjrudinrjrudin
committed
MLE-23230 Better name for retry interceptor
And added comments to explain what the existing app-level retry support is doing vs what this for-now-undocumented interceptor will be doing.
1 parent ccfd3e7 commit c9817ea

7 files changed

Lines changed: 99 additions & 53 deletions

File tree

‎marklogic-client-api-functionaltests/src/test/java/com/marklogic/client/functionaltest/ConnectedRESTQA.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
import com.marklogic.client.admin.ServerConfigurationManager;
1818
import com.marklogic.client.extra.okhttpclient.OkHttpClientConfigurator;
1919
import com.marklogic.client.impl.SSLUtil;
20-
import com.marklogic.client.impl.okhttp.RetryInterceptor;
20+
import com.marklogic.client.impl.okhttp.RetryIOExceptionInterceptor;
2121
import com.marklogic.client.io.DocumentMetadataHandle;
2222
import com.marklogic.client.io.DocumentMetadataHandle.Capability;
2323
import com.marklogic.client.query.QueryManager;
@@ -50,7 +50,7 @@ public abstract class ConnectedRESTQA {
5050
static {
5151
DatabaseClientFactory.removeConfigurators();
5252
DatabaseClientFactory.addConfigurator((OkHttpClientConfigurator) client ->
53-
client.addInterceptor(new RetryInterceptor(3, 1000, 2, 8000)));
53+
client.addInterceptor(new RetryIOExceptionInterceptor(3, 1000, 2, 8000)));
5454
}
5555

5656
private static Properties testProperties = null;

‎marklogic-client-api/src/main/java/com/marklogic/client/impl/OkHttpServices.java‎

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
import com.marklogic.client.impl.okhttp.HttpUrlBuilder;
2323
import com.marklogic.client.impl.okhttp.OkHttpUtil;
2424
import com.marklogic.client.impl.okhttp.PartIterator;
25+
import com.marklogic.client.impl.okhttp.RetryableRequestBody;
2526
import com.marklogic.client.io.*;
2627
import com.marklogic.client.io.marker.*;
2728
import com.marklogic.client.query.*;
@@ -99,15 +100,19 @@ public class OkHttpServices implements RESTServices {
99100

100101
private boolean released = false;
101102

103+
/**
104+
* The next 4 fields implement an application-level retry that only works for certain HTTP status codes. It will not
105+
* attempt a retry on any IOException or any type of connection failure. Sadly, the logic that uses these fields is
106+
* in several places and is slightly different in each place. It's also not possible to implement this logic in an
107+
* OkHttp interceptor as the logic needs access to details that are not available to an interceptor.
108+
*/
102109
private final Random randRetry = new Random();
103-
104110
private int maxDelay = DEFAULT_MAX_DELAY;
105111
private int minRetry = DEFAULT_MIN_RETRY;
112+
private final Set<Integer> retryStatus = new HashSet<>();
106113

107114
private boolean checkFirstRequest = true;
108115

109-
private final Set<Integer> retryStatus = new HashSet<>();
110-
111116
static protected class ThreadState {
112117
boolean isFirstRequest;
113118

@@ -5408,7 +5413,8 @@ static private List<BodyPart> getPartList(MimeMultipart multipart) {
54085413
}
54095414
}
54105415

5411-
static private class ObjectRequestBody extends RequestBody {
5416+
static private class ObjectRequestBody extends RequestBody implements RetryableRequestBody {
5417+
54125418
private Object obj;
54135419
private MediaType contentType;
54145420

@@ -5442,6 +5448,13 @@ public void writeTo(BufferedSink sink) throws IOException {
54425448
throw new IllegalStateException("Cannot write object of type: " + obj.getClass());
54435449
}
54445450
}
5451+
5452+
@Override
5453+
public boolean isRetryable() {
5454+
// Added in 8.0.0 to work with the retry interceptor so it knows whether the body can be retried or not.
5455+
// InputStreams cannot be retried as they are consumed on first read.
5456+
return !(obj instanceof InputStream);
5457+
}
54455458
}
54465459

54475460
// API First Changes

‎marklogic-client-api/src/main/java/com/marklogic/client/impl/StreamingOutputImpl.java‎

Lines changed: 45 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -3,46 +3,54 @@
33
*/
44
package com.marklogic.client.impl;
55

6-
import java.io.IOException;
7-
import java.io.OutputStream;
8-
9-
import com.marklogic.client.util.RequestLogger;
6+
import com.marklogic.client.impl.okhttp.RetryableRequestBody;
107
import com.marklogic.client.io.OutputStreamSender;
8+
import com.marklogic.client.util.RequestLogger;
119
import okhttp3.MediaType;
1210
import okhttp3.RequestBody;
1311
import okio.BufferedSink;
1412

15-
class StreamingOutputImpl extends RequestBody {
16-
private OutputStreamSender handle;
17-
private RequestLogger logger;
18-
private MediaType contentType;
19-
20-
StreamingOutputImpl(OutputStreamSender handle, RequestLogger logger, MediaType contentType) {
21-
super();
22-
this.handle = handle;
23-
this.logger = logger;
24-
this.contentType = contentType;
25-
}
26-
27-
@Override
28-
public MediaType contentType() {
29-
return contentType;
30-
}
31-
32-
@Override
33-
public void writeTo(BufferedSink sink) throws IOException {
34-
OutputStream out = sink.outputStream();
35-
36-
if (logger != null) {
37-
OutputStream tee = logger.getPrintStream();
38-
long max = logger.getContentMax();
39-
if (tee != null && max > 0) {
40-
handle.write(new OutputStreamTee(out, tee, max));
41-
42-
return;
43-
}
44-
}
45-
46-
handle.write(out);
47-
}
13+
import java.io.IOException;
14+
import java.io.OutputStream;
15+
16+
class StreamingOutputImpl extends RequestBody implements RetryableRequestBody {
17+
18+
private OutputStreamSender handle;
19+
private RequestLogger logger;
20+
private MediaType contentType;
21+
22+
StreamingOutputImpl(OutputStreamSender handle, RequestLogger logger, MediaType contentType) {
23+
super();
24+
this.handle = handle;
25+
this.logger = logger;
26+
this.contentType = contentType;
27+
}
28+
29+
@Override
30+
public MediaType contentType() {
31+
return contentType;
32+
}
33+
34+
@Override
35+
public void writeTo(BufferedSink sink) throws IOException {
36+
OutputStream out = sink.outputStream();
37+
38+
if (logger != null) {
39+
OutputStream tee = logger.getPrintStream();
40+
long max = logger.getContentMax();
41+
if (tee != null && max > 0) {
42+
handle.write(new OutputStreamTee(out, tee, max));
43+
44+
return;
45+
}
46+
}
47+
48+
handle.write(out);
49+
}
50+
51+
@Override
52+
public boolean isRetryable() {
53+
// Added in 8.0.0; streaming output cannot be retried as the stream is consumed on first write.
54+
return false;
55+
}
4856
}

marklogic-client-api/src/main/java/com/marklogic/client/impl/okhttp/RetryInterceptor.java renamed to marklogic-client-api/src/main/java/com/marklogic/client/impl/okhttp/RetryIOExceptionInterceptor.java

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,22 @@
1414
import java.net.UnknownHostException;
1515

1616
/**
17-
* OkHttp interceptor that retries requests on certain connection failures,
18-
* which can be helpful when MarkLogic is temporarily unavailable during restarts.
17+
* Experimental interceptor added in 8.0.0 for retrying requests that fail due to connection issues. These issues are
18+
* not handled by the application-level retry support in OkHttpServices, which only handles retries based on certain
19+
* HTTP status codes. The main limitation of this approach is that it cannot retry a request that has a one-shot body,
20+
* such as a streaming body. But for requests that don't have one-shot bodies, this interceptor can be helpful for
21+
* retrying requests that fail due to temporary network issues or MarkLogic restarts.
1922
*/
20-
public class RetryInterceptor implements Interceptor {
23+
public class RetryIOExceptionInterceptor implements Interceptor {
2124

22-
private final static Logger logger = org.slf4j.LoggerFactory.getLogger(RetryInterceptor.class);
25+
private final static Logger logger = org.slf4j.LoggerFactory.getLogger(RetryIOExceptionInterceptor.class);
2326

2427
private final int maxRetries;
2528
private final long initialDelayMs;
2629
private final double backoffMultiplier;
2730
private final long maxDelayMs;
2831

29-
public RetryInterceptor(int maxRetries, long initialDelayMs, double backoffMultiplier, long maxDelayMs) {
32+
public RetryIOExceptionInterceptor(int maxRetries, long initialDelayMs, double backoffMultiplier, long maxDelayMs) {
3033
this.maxRetries = maxRetries;
3134
this.initialDelayMs = initialDelayMs;
3235
this.backoffMultiplier = backoffMultiplier;
@@ -37,11 +40,15 @@ public RetryInterceptor(int maxRetries, long initialDelayMs, double backoffMulti
3740
public Response intercept(Chain chain) throws IOException {
3841
Request request = chain.request();
3942

43+
if (request.body() instanceof RetryableRequestBody body && !body.isRetryable()) {
44+
return chain.proceed(request);
45+
}
46+
4047
for (int attempt = 0; attempt <= maxRetries; attempt++) {
4148
try {
4249
return chain.proceed(request);
4350
} catch (IOException e) {
44-
if (attempt == maxRetries || !isRetryableException(e)) {
51+
if (attempt == maxRetries || !isRetryableIOException(e)) {
4552
logger.warn("Not retryable: {}; {}", e.getClass(), e.getMessage());
4653
throw e;
4754
}
@@ -58,7 +65,7 @@ public Response intercept(Chain chain) throws IOException {
5865
throw new IllegalStateException("Unexpected end of retry loop");
5966
}
6067

61-
private boolean isRetryableException(IOException e) {
68+
private boolean isRetryableIOException(IOException e) {
6269
return e instanceof ConnectException ||
6370
e instanceof SocketTimeoutException ||
6471
e instanceof UnknownHostException ||

‎marklogic-client-api/src/main/java/com/marklogic/client/impl/okhttp/RetryableRequestBody.java‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
/*
2+
* Copyright (c) 2010-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
3+
*/
4+
package com.marklogic.client.impl.okhttp;
5+
6+
/**
7+
* Interface for RequestBody implementations to signal whether they can be retried after an IOException.
8+
* This is used by RetryIOExceptionInterceptor to determine if a failed request can be retried.
9+
* Added in 8.0.0.
10+
*/
11+
public interface RetryableRequestBody {
12+
/**
13+
* @return false if this request body cannot be retried (e.g., because it consumes a stream that can only be
14+
* read once); true if it can be safely retried.
15+
*/
16+
boolean isRetryable();
17+
}

‎marklogic-client-api/src/test/java/com/marklogic/client/test/Common.java‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,10 @@
99
import com.marklogic.client.DatabaseClientBuilder;
1010
import com.marklogic.client.DatabaseClientFactory;
1111
import com.marklogic.client.extra.okhttpclient.OkHttpClientConfigurator;
12-
import com.marklogic.client.impl.okhttp.RetryInterceptor;
12+
import com.marklogic.client.impl.okhttp.RetryIOExceptionInterceptor;
1313
import com.marklogic.client.io.DocumentMetadataHandle;
1414
import com.marklogic.mgmt.ManageClient;
1515
import com.marklogic.mgmt.ManageConfig;
16-
import okhttp3.OkHttpClient;
1716
import org.springframework.util.FileCopyUtils;
1817
import org.w3c.dom.DOMException;
1918
import org.w3c.dom.Document;
@@ -35,7 +34,7 @@ public class Common {
3534
static {
3635
DatabaseClientFactory.removeConfigurators();
3736
DatabaseClientFactory.addConfigurator((OkHttpClientConfigurator) client ->
38-
client.addInterceptor(new RetryInterceptor(3, 1000, 2, 8000)));
37+
client.addInterceptor(new RetryIOExceptionInterceptor(3, 1000, 2, 8000)));
3938
}
4039

4140
final public static String USER = "rest-writer";

‎marklogic-client-api/src/test/java/com/marklogic/client/test/datamovement/RowBatcherTest.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
import com.marklogic.client.type.PlanSystemColumn;
2525
import org.junit.jupiter.api.AfterAll;
2626
import org.junit.jupiter.api.BeforeAll;
27+
import org.junit.jupiter.api.Disabled;
2728
import org.junit.jupiter.api.Test;
2829
import org.w3c.dom.Document;
2930
import org.w3c.dom.Element;
@@ -190,6 +191,7 @@ public void testJsonDocs1Thread() throws Exception {
190191
}
191192

192193
@Test
194+
@Disabled("A query returning no rows is now throwing an IOException on 12 nightly, so disabling temporarily.")
193195
void noRowsReturned() {
194196
RowBatcher<JsonNode> rowBatcher = jsonBatcher(1);
195197
RowManager rowMgr = rowBatcher.getRowManager();

0 commit comments

Comments
 (0)