-
Notifications
You must be signed in to change notification settings - Fork 73
MLE-27388 Added test for 50x retry #1916
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
Merged
Merged
Changes from all commits
Commits
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
160 changes: 160 additions & 0 deletions
160
...gic-client-api/src/test/java/com/marklogic/client/impl/okhttp/RetryOn50XResponseTest.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,160 @@ | ||
| /* | ||
| * Copyright (c) 2010-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved. | ||
| */ | ||
| package com.marklogic.client.impl.okhttp; | ||
|
|
||
| import com.marklogic.client.DatabaseClient; | ||
| import com.marklogic.client.DatabaseClientFactory; | ||
| import com.marklogic.client.FailedRequestException; | ||
| import com.marklogic.client.extra.okhttpclient.OkHttpClientConfigurator; | ||
| import com.marklogic.client.impl.RESTServices; | ||
| import com.marklogic.client.test.Common; | ||
| import okhttp3.Interceptor; | ||
| import okhttp3.Protocol; | ||
| import okhttp3.Request; | ||
| import okhttp3.Response; | ||
| import org.junit.jupiter.api.AfterEach; | ||
| import org.junit.jupiter.api.BeforeEach; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.concurrent.atomic.AtomicInteger; | ||
|
|
||
| import static org.junit.jupiter.api.Assertions.*; | ||
|
|
||
| /** | ||
| * Tests the retry logic in OkHttpServices using a custom interceptor that simulates server errors. This is not a | ||
| * well-documented feature but users are currently able to discover it via the codebase. | ||
| */ | ||
| class RetryOn50XResponseTest { | ||
|
|
||
| /** | ||
| * Custom interceptor that returns 502 Bad Gateway responses and counts how many times it's invoked. | ||
| */ | ||
| private static class BadGatewayInterceptor implements Interceptor { | ||
|
|
||
| private final AtomicInteger invocationCount = new AtomicInteger(0); | ||
| private final int failureCount; | ||
|
|
||
| /** | ||
| * @param failureCount Number of times to return 502 before allowing the request through | ||
| */ | ||
| public BadGatewayInterceptor(int failureCount) { | ||
| this.failureCount = failureCount; | ||
| } | ||
|
|
||
| @Override | ||
| public Response intercept(Chain chain) throws IOException { | ||
| int count = invocationCount.incrementAndGet(); | ||
| Request request = chain.request(); | ||
|
|
||
| // Fail the first N requests | ||
| if (count <= failureCount) { | ||
| return new Response.Builder() | ||
| .request(request) | ||
| .protocol(Protocol.HTTP_1_1) | ||
| .code(502) | ||
| .message("Bad Gateway") | ||
| .body(okhttp3.ResponseBody.create("Simulated 502 error", null)) | ||
| .build(); | ||
| } | ||
|
|
||
| // After N failures, let the request through | ||
| return chain.proceed(request); | ||
| } | ||
|
|
||
| public int getInvocationCount() { | ||
| return invocationCount.get(); | ||
| } | ||
|
|
||
| public void reset() { | ||
| invocationCount.set(0); | ||
| } | ||
| } | ||
|
|
||
| @BeforeEach | ||
| void setUp() { | ||
| // Configure very short retry delays for testing | ||
| System.setProperty(RESTServices.MAX_DELAY_PROP, "3"); | ||
| System.setProperty(RESTServices.MIN_RETRY_PROP, "2"); | ||
|
|
||
| // "Touch" the Common class to trigger the static block that removes existing configurators on | ||
| // DatabaseClientFactory. | ||
| Common.newServerPayload(); | ||
| } | ||
|
Comment on lines
+75
to
+84
|
||
|
|
||
| @AfterEach | ||
| void tearDown() { | ||
| DatabaseClientFactory.removeConfigurators(); | ||
| System.clearProperty(RESTServices.MAX_DELAY_PROP); | ||
| System.clearProperty(RESTServices.MIN_RETRY_PROP); | ||
| } | ||
|
|
||
| @Test | ||
| void testRetryWith502Responses() { | ||
| // Create an interceptor that will fail 2 times, then succeed | ||
| BadGatewayInterceptor interceptor = new BadGatewayInterceptor(2); | ||
|
|
||
| DatabaseClientFactory.addConfigurator((OkHttpClientConfigurator) builder -> | ||
| builder.addInterceptor(interceptor)); | ||
|
|
||
| try (DatabaseClient client = Common.newClient()) { | ||
| client.checkConnection(); | ||
| assertEquals(3, interceptor.getInvocationCount(), | ||
| "Expected 3 invocations: 2 failures followed by 1 success"); | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| void testRetryExceedsMaxAttempts() { | ||
| // Create an interceptor that will fail 10 times (more than minRetry) | ||
| BadGatewayInterceptor interceptor = new BadGatewayInterceptor(10); | ||
|
|
||
| DatabaseClientFactory.addConfigurator((OkHttpClientConfigurator) builder -> | ||
| builder.addInterceptor(interceptor)); | ||
|
|
||
| try (DatabaseClient client = Common.newClient()) { | ||
| assertThrows(FailedRequestException.class, () -> { | ||
| client.checkConnection(); | ||
| }, "Expected FailedRequestException after exhausting retries"); | ||
|
|
||
| assertTrue(interceptor.getInvocationCount() >= 3, | ||
| "Expected at least 3 retry attempts, but got " + interceptor.getInvocationCount()); | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| void testRetryCountIncreases() { | ||
| // Test that retry attempts increase as expected | ||
| BadGatewayInterceptor interceptor = new BadGatewayInterceptor(1); | ||
|
|
||
| DatabaseClientFactory.addConfigurator((OkHttpClientConfigurator) builder -> | ||
| builder.addInterceptor(interceptor)); | ||
|
|
||
| try (DatabaseClient client = Common.newClient()) { | ||
| // First request: fails once, then succeeds | ||
| client.checkConnection(); | ||
| assertEquals(2, interceptor.getInvocationCount(), "Expected 2 invocations for first request"); | ||
|
|
||
| // Reset and try again | ||
| interceptor.reset(); | ||
| client.checkConnection(); | ||
| assertEquals(2, interceptor.getInvocationCount(), "Expected 2 invocations for second request"); | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| void testNoRetryOnSuccessfulRequest() { | ||
| // Interceptor that never fails | ||
| BadGatewayInterceptor interceptor = new BadGatewayInterceptor(0); | ||
|
|
||
| DatabaseClientFactory.addConfigurator((OkHttpClientConfigurator) builder -> | ||
| builder.addInterceptor(interceptor)); | ||
|
|
||
| try (DatabaseClient client = Common.newClient()) { | ||
| client.checkConnection(); | ||
| assertEquals(1, interceptor.getInvocationCount(), | ||
| "Expected exactly 1 invocation when request succeeds immediately"); | ||
| } | ||
| } | ||
| } | ||
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 | ||||
|---|---|---|---|---|---|---|
|
|
@@ -16,4 +16,8 @@ | |||||
| <appender-ref ref="STDOUT" /> | ||||||
| </logger> | ||||||
|
|
||||||
| <logger name="com.marklogic.client.impl.RetryContext" level="DEBUG" additivity="false"> | ||||||
|
||||||
| <logger name="com.marklogic.client.impl.RetryContext" level="DEBUG" additivity="false"> | |
| <logger name="com.marklogic.client.impl.RetryContext" level="WARN" additivity="false"> |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Common.newServerPayload()is used here only to force Common's static initializer to run and clear existing configurators. That initializer will only run once per JVM, so subsequent test methods won't get any reset behavior from this call. For better test isolation, consider explicitly callingDatabaseClientFactory.removeConfigurators()(and then adding only the configurators this test needs) instead of relying on a one-time class initialization side effect.