Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added retry logic if client request returns an error code that is con…
…figured for retrying Closes #4408 Added additional tests for coverage Included example of comma separated values for retry-error-codes config parameter Simplified retry loop logic Moved retry configurations into constructor and removed setters Signed-off-by: Allan Clements <[email protected]>
- Loading branch information
1 parent
0d601cf
commit d75cfe6
There are no files selected for viewing
This file contains 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 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 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 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 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,156 @@ | ||
| // Copyright 2024 JanusGraph Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package org.janusgraph.diskstorage.es.rest; | ||
|
|
||
| import com.google.common.collect.Sets; | ||
| import org.apache.http.StatusLine; | ||
| import org.elasticsearch.client.Request; | ||
| import org.elasticsearch.client.Response; | ||
| import org.elasticsearch.client.ResponseException; | ||
| import org.elasticsearch.client.RestClient; | ||
| import org.junit.jupiter.api.Assertions; | ||
| import org.junit.jupiter.api.Test; | ||
| import org.junit.jupiter.api.extension.ExtendWith; | ||
| import org.mockito.ArgumentCaptor; | ||
| import org.mockito.Captor; | ||
| import org.mockito.Mock; | ||
| import org.mockito.Mockito; | ||
| import org.mockito.junit.jupiter.MockitoExtension; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.Collections; | ||
| import java.util.Set; | ||
|
|
||
| import static org.mockito.ArgumentMatchers.any; | ||
| import static org.mockito.Mockito.doReturn; | ||
| import static org.mockito.Mockito.mock; | ||
| import static org.mockito.Mockito.times; | ||
| import static org.mockito.Mockito.verify; | ||
| import static org.mockito.Mockito.when; | ||
|
|
||
| @ExtendWith(MockitoExtension.class) | ||
| public class RestClientRetryTest { | ||
| @Mock | ||
| private RestClient restClientMock; | ||
|
|
||
| @Mock | ||
| private ResponseException responseException; | ||
|
|
||
| @Mock | ||
| private Response response; | ||
|
|
||
| @Mock | ||
| private StatusLine statusLine; | ||
|
|
||
| @Captor | ||
| private ArgumentCaptor<Request> requestCaptor; | ||
|
|
||
| RestElasticSearchClient createClient(int retryAttemptLimit, Set<Integer> retryErrorCodes) throws IOException { | ||
| //Just throw an exception when there's an attempt to look up the ES version during instantiation | ||
| when(restClientMock.performRequest(any())).thenThrow(new IOException()); | ||
|
|
||
| RestElasticSearchClient clientUnderTest = new RestElasticSearchClient(restClientMock, 0, false, | ||
| retryAttemptLimit, retryErrorCodes, 0, 0); | ||
| //There's an initial query to get the ES version we need to accommodate, and then reset for the actual test | ||
| Mockito.reset(restClientMock); | ||
| return clientUnderTest; | ||
| } | ||
|
|
||
| @Test | ||
| public void testRetryOnConfiguredErrorStatus() throws IOException { | ||
| Integer retryCode = 429; | ||
| int expectedNumberOfRequestAttempts = 2; | ||
| doReturn(retryCode).when(statusLine).getStatusCode(); | ||
| doReturn(statusLine).when(response).getStatusLine(); | ||
| doReturn(response).when(responseException).getResponse(); | ||
| //Just throw an expected exception the second time to confirm the retry occurred | ||
| //rather than mock out a parsable response | ||
| IOException expectedFinalException = new IOException("Expected"); | ||
|
|
||
| try (RestElasticSearchClient restClientUnderTest = createClient(expectedNumberOfRequestAttempts - 1, | ||
| Sets.newHashSet(retryCode))) { | ||
| //prime the restClientMock again after it's reset after creation | ||
| when(restClientMock.performRequest(any())) | ||
| .thenThrow(responseException) | ||
| .thenThrow(expectedFinalException); | ||
| restClientUnderTest.bulkRequest(Collections.emptyList(), null); | ||
| Assertions.fail("Should have thrown the expected exception after retry"); | ||
| } catch (Exception actualException) { | ||
| Assertions.assertSame(expectedFinalException, actualException); | ||
| } | ||
| verify(restClientMock, times(expectedNumberOfRequestAttempts)).performRequest(requestCaptor.capture()); | ||
| } | ||
|
|
||
| @Test | ||
| public void testRetriesExhaustedReturnsLastRetryException() throws IOException { | ||
| Integer retryCode = 429; | ||
| int expectedNumberOfRequestAttempts = 2; | ||
| doReturn(retryCode).when(statusLine).getStatusCode(); | ||
| doReturn(statusLine).when(response).getStatusLine(); | ||
| doReturn(response).when(responseException).getResponse(); | ||
| ResponseException initialRetryException = mock(ResponseException.class); | ||
| doReturn(response).when(initialRetryException).getResponse(); | ||
|
|
||
| try (RestElasticSearchClient restClientUnderTest = createClient(expectedNumberOfRequestAttempts - 1, | ||
| Sets.newHashSet(retryCode))) { | ||
| //prime the restClientMock again after it's reset after creation | ||
| when(restClientMock.performRequest(any())) | ||
| //first throw a different retry exception instance, then make sure it's the latter one | ||
| //that was retained and then thrown | ||
| .thenThrow(initialRetryException) | ||
| .thenThrow(responseException); | ||
|
|
||
|
|
||
| restClientUnderTest.bulkRequest(Collections.emptyList(), null); | ||
| Assertions.fail("Should have thrown the expected exception after retry"); | ||
| } catch (Exception e) { | ||
| Assertions.assertSame(responseException, e); | ||
| } | ||
| verify(restClientMock, times(expectedNumberOfRequestAttempts)).performRequest(requestCaptor.capture()); | ||
| } | ||
|
|
||
| @Test | ||
| public void testNonRetryErrorCodeException() throws IOException { | ||
| doReturn(503).when(statusLine).getStatusCode(); | ||
| doReturn(statusLine).when(response).getStatusLine(); | ||
| doReturn(response).when(responseException).getResponse(); | ||
| try (RestElasticSearchClient restClientUnderTest = createClient(0, | ||
| //Other retry error code is configured | ||
| Sets.newHashSet(429))) { | ||
| //prime the restClientMock again after it's reset after creation | ||
| when(restClientMock.performRequest(any())) | ||
| .thenThrow(responseException); | ||
| restClientUnderTest.bulkRequest(Collections.emptyList(), null); | ||
| Assertions.fail("Should have thrown the expected exception"); | ||
| } catch (Exception e) { | ||
| Assertions.assertSame(responseException, e); | ||
| } | ||
| verify(restClientMock, times(1)).performRequest(requestCaptor.capture()); | ||
| } | ||
|
|
||
| @Test | ||
| public void testNonResponseExceptionErrorThrown() throws IOException { | ||
| IOException differentExceptionType = new IOException(); | ||
| when(restClientMock.performRequest(any())) | ||
| .thenThrow(differentExceptionType); | ||
| try (RestElasticSearchClient restClientUnderTest = createClient(0, Collections.emptySet())) { | ||
| restClientUnderTest.bulkRequest(Collections.emptyList(), null); | ||
| Assertions.fail("Should have thrown the expected exception"); | ||
| } catch (Exception e) { | ||
| Assertions.assertSame(differentExceptionType, e); | ||
| } | ||
| verify(restClientMock, times(1)).performRequest(requestCaptor.capture()); | ||
| } | ||
| } |
Oops, something went wrong.