|
| 1 | +/* |
| 2 | + * Copyright (c) 2010-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved. |
| 3 | + */ |
| 4 | +package com.marklogic.client.impl.okhttp; |
| 5 | + |
| 6 | +import com.marklogic.client.DatabaseClient; |
| 7 | +import com.marklogic.client.DatabaseClientFactory; |
| 8 | +import com.marklogic.client.FailedRequestException; |
| 9 | +import com.marklogic.client.extra.okhttpclient.OkHttpClientConfigurator; |
| 10 | +import com.marklogic.client.impl.RESTServices; |
| 11 | +import com.marklogic.client.test.Common; |
| 12 | +import okhttp3.Interceptor; |
| 13 | +import okhttp3.Protocol; |
| 14 | +import okhttp3.Request; |
| 15 | +import okhttp3.Response; |
| 16 | +import org.junit.jupiter.api.AfterEach; |
| 17 | +import org.junit.jupiter.api.BeforeEach; |
| 18 | +import org.junit.jupiter.api.Test; |
| 19 | + |
| 20 | +import java.io.IOException; |
| 21 | +import java.util.concurrent.atomic.AtomicInteger; |
| 22 | + |
| 23 | +import static org.junit.jupiter.api.Assertions.*; |
| 24 | + |
| 25 | +/** |
| 26 | + * Tests the retry logic in OkHttpServices using a custom interceptor that simulates server errors. This is not a |
| 27 | + * well-documented feature but users are currently able to discover it via the codebase. |
| 28 | + */ |
| 29 | +class RetryOn50XResponseTest { |
| 30 | + |
| 31 | + /** |
| 32 | + * Custom interceptor that returns 502 Bad Gateway responses and counts how many times it's invoked. |
| 33 | + */ |
| 34 | + private static class BadGatewayInterceptor implements Interceptor { |
| 35 | + |
| 36 | + private final AtomicInteger invocationCount = new AtomicInteger(0); |
| 37 | + private final int failureCount; |
| 38 | + |
| 39 | + /** |
| 40 | + * @param failureCount Number of times to return 502 before allowing the request through |
| 41 | + */ |
| 42 | + public BadGatewayInterceptor(int failureCount) { |
| 43 | + this.failureCount = failureCount; |
| 44 | + } |
| 45 | + |
| 46 | + @Override |
| 47 | + public Response intercept(Chain chain) throws IOException { |
| 48 | + int count = invocationCount.incrementAndGet(); |
| 49 | + Request request = chain.request(); |
| 50 | + |
| 51 | + // Fail the first N requests |
| 52 | + if (count <= failureCount) { |
| 53 | + return new Response.Builder() |
| 54 | + .request(request) |
| 55 | + .protocol(Protocol.HTTP_1_1) |
| 56 | + .code(502) |
| 57 | + .message("Bad Gateway") |
| 58 | + .body(okhttp3.ResponseBody.create("Simulated 502 error", null)) |
| 59 | + .build(); |
| 60 | + } |
| 61 | + |
| 62 | + // After N failures, let the request through |
| 63 | + return chain.proceed(request); |
| 64 | + } |
| 65 | + |
| 66 | + public int getInvocationCount() { |
| 67 | + return invocationCount.get(); |
| 68 | + } |
| 69 | + |
| 70 | + public void reset() { |
| 71 | + invocationCount.set(0); |
| 72 | + } |
| 73 | + } |
| 74 | + |
| 75 | + @BeforeEach |
| 76 | + void setUp() { |
| 77 | + // Configure very short retry delays for testing |
| 78 | + System.setProperty(RESTServices.MAX_DELAY_PROP, "3"); |
| 79 | + System.setProperty(RESTServices.MIN_RETRY_PROP, "2"); |
| 80 | + |
| 81 | + // "Touch" the Common class to trigger the static block that removes existing configurators on |
| 82 | + // DatabaseClientFactory. |
| 83 | + Common.newServerPayload(); |
| 84 | + } |
| 85 | + |
| 86 | + @AfterEach |
| 87 | + void tearDown() { |
| 88 | + DatabaseClientFactory.removeConfigurators(); |
| 89 | + System.clearProperty(RESTServices.MAX_DELAY_PROP); |
| 90 | + System.clearProperty(RESTServices.MIN_RETRY_PROP); |
| 91 | + } |
| 92 | + |
| 93 | + @Test |
| 94 | + void testRetryWith502Responses() { |
| 95 | + // Create an interceptor that will fail 2 times, then succeed |
| 96 | + BadGatewayInterceptor interceptor = new BadGatewayInterceptor(2); |
| 97 | + |
| 98 | + DatabaseClientFactory.addConfigurator((OkHttpClientConfigurator) builder -> |
| 99 | + builder.addInterceptor(interceptor)); |
| 100 | + |
| 101 | + try (DatabaseClient client = Common.newClient()) { |
| 102 | + client.checkConnection(); |
| 103 | + assertEquals(3, interceptor.getInvocationCount(), |
| 104 | + "Expected 3 invocations: 2 failures followed by 1 success"); |
| 105 | + } |
| 106 | + } |
| 107 | + |
| 108 | + @Test |
| 109 | + void testRetryExceedsMaxAttempts() { |
| 110 | + // Create an interceptor that will fail 10 times (more than minRetry) |
| 111 | + BadGatewayInterceptor interceptor = new BadGatewayInterceptor(10); |
| 112 | + |
| 113 | + DatabaseClientFactory.addConfigurator((OkHttpClientConfigurator) builder -> |
| 114 | + builder.addInterceptor(interceptor)); |
| 115 | + |
| 116 | + try (DatabaseClient client = Common.newClient()) { |
| 117 | + assertThrows(FailedRequestException.class, () -> { |
| 118 | + client.checkConnection(); |
| 119 | + }, "Expected FailedRequestException after exhausting retries"); |
| 120 | + |
| 121 | + assertTrue(interceptor.getInvocationCount() >= 3, |
| 122 | + "Expected at least 3 retry attempts, but got " + interceptor.getInvocationCount()); |
| 123 | + } |
| 124 | + } |
| 125 | + |
| 126 | + @Test |
| 127 | + void testRetryCountIncreases() { |
| 128 | + // Test that retry attempts increase as expected |
| 129 | + BadGatewayInterceptor interceptor = new BadGatewayInterceptor(1); |
| 130 | + |
| 131 | + DatabaseClientFactory.addConfigurator((OkHttpClientConfigurator) builder -> |
| 132 | + builder.addInterceptor(interceptor)); |
| 133 | + |
| 134 | + try (DatabaseClient client = Common.newClient()) { |
| 135 | + // First request: fails once, then succeeds |
| 136 | + client.checkConnection(); |
| 137 | + assertEquals(2, interceptor.getInvocationCount(), "Expected 2 invocations for first request"); |
| 138 | + |
| 139 | + // Reset and try again |
| 140 | + interceptor.reset(); |
| 141 | + client.checkConnection(); |
| 142 | + assertEquals(2, interceptor.getInvocationCount(), "Expected 2 invocations for second request"); |
| 143 | + } |
| 144 | + } |
| 145 | + |
| 146 | + @Test |
| 147 | + void testNoRetryOnSuccessfulRequest() { |
| 148 | + // Interceptor that never fails |
| 149 | + BadGatewayInterceptor interceptor = new BadGatewayInterceptor(0); |
| 150 | + |
| 151 | + DatabaseClientFactory.addConfigurator((OkHttpClientConfigurator) builder -> |
| 152 | + builder.addInterceptor(interceptor)); |
| 153 | + |
| 154 | + try (DatabaseClient client = Common.newClient()) { |
| 155 | + client.checkConnection(); |
| 156 | + assertEquals(1, interceptor.getInvocationCount(), |
| 157 | + "Expected exactly 1 invocation when request succeeds immediately"); |
| 158 | + } |
| 159 | + } |
| 160 | +} |
0 commit comments