-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
API, AWS: Retry S3InputStream reads (#10433)
Co-authored-by: Jack Ye <[email protected]> Co-authored-by: Xiaoxuan Li <[email protected]>
- Loading branch information
3 people
authored
Sep 24, 2024
1 parent
72fd9ab
commit c0d73f4
Showing
5 changed files
with
285 additions
and
20 deletions.
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
206 changes: 206 additions & 0 deletions
206
aws/src/test/java/org/apache/iceberg/aws/s3/TestFlakyS3InputStream.java
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,206 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you 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.apache.iceberg.aws.s3; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThatThrownBy; | ||
| import static org.mockito.ArgumentMatchers.any; | ||
| import static org.mockito.Mockito.doAnswer; | ||
| import static org.mockito.Mockito.spy; | ||
|
|
||
| import java.io.IOException; | ||
| import java.io.InputStream; | ||
| import java.net.SocketTimeoutException; | ||
| import java.util.concurrent.atomic.AtomicInteger; | ||
| import java.util.stream.Stream; | ||
| import javax.net.ssl.SSLException; | ||
| import org.junit.jupiter.params.ParameterizedTest; | ||
| import org.junit.jupiter.params.provider.Arguments; | ||
| import org.junit.jupiter.params.provider.MethodSource; | ||
| import software.amazon.awssdk.awscore.exception.AwsServiceException; | ||
| import software.amazon.awssdk.core.ResponseInputStream; | ||
| import software.amazon.awssdk.core.exception.SdkClientException; | ||
| import software.amazon.awssdk.core.sync.RequestBody; | ||
| import software.amazon.awssdk.core.sync.ResponseTransformer; | ||
| import software.amazon.awssdk.services.s3.S3Client; | ||
| import software.amazon.awssdk.services.s3.model.CreateBucketRequest; | ||
| import software.amazon.awssdk.services.s3.model.CreateBucketResponse; | ||
| import software.amazon.awssdk.services.s3.model.GetObjectRequest; | ||
| import software.amazon.awssdk.services.s3.model.GetObjectResponse; | ||
| import software.amazon.awssdk.services.s3.model.HeadObjectRequest; | ||
| import software.amazon.awssdk.services.s3.model.HeadObjectResponse; | ||
| import software.amazon.awssdk.services.s3.model.PutObjectRequest; | ||
| import software.amazon.awssdk.services.s3.model.PutObjectResponse; | ||
|
|
||
| public class TestFlakyS3InputStream extends TestS3InputStream { | ||
|
|
||
| @ParameterizedTest | ||
| @MethodSource("retryableExceptions") | ||
| public void testReadWithFlakyStreamRetrySucceed(IOException exception) throws Exception { | ||
| testRead(flakyStreamClient(new AtomicInteger(3), exception)); | ||
| } | ||
|
|
||
| @ParameterizedTest | ||
| @MethodSource("retryableExceptions") | ||
| public void testReadWithFlakyStreamExhaustedRetries(IOException exception) { | ||
| assertThatThrownBy(() -> testRead(flakyStreamClient(new AtomicInteger(5), exception))) | ||
| .isInstanceOf(exception.getClass()) | ||
| .hasMessage(exception.getMessage()); | ||
| } | ||
|
|
||
| @ParameterizedTest | ||
| @MethodSource("nonRetryableExceptions") | ||
| public void testReadWithFlakyStreamNonRetryableException(IOException exception) { | ||
| assertThatThrownBy(() -> testRead(flakyStreamClient(new AtomicInteger(3), exception))) | ||
| .isInstanceOf(exception.getClass()) | ||
| .hasMessage(exception.getMessage()); | ||
| } | ||
|
|
||
| @ParameterizedTest | ||
| @MethodSource("retryableExceptions") | ||
| public void testSeekWithFlakyStreamRetrySucceed(IOException exception) throws Exception { | ||
| testSeek(flakyStreamClient(new AtomicInteger(3), exception)); | ||
| } | ||
|
|
||
| @ParameterizedTest | ||
| @MethodSource("retryableExceptions") | ||
| public void testSeekWithFlakyStreamExhaustedRetries(IOException exception) { | ||
| assertThatThrownBy(() -> testSeek(flakyStreamClient(new AtomicInteger(5), exception))) | ||
| .isInstanceOf(exception.getClass()) | ||
| .hasMessage(exception.getMessage()); | ||
| } | ||
|
|
||
| @ParameterizedTest | ||
| @MethodSource("nonRetryableExceptions") | ||
| public void testSeekWithFlakyStreamNonRetryableException(IOException exception) { | ||
| assertThatThrownBy(() -> testSeek(flakyStreamClient(new AtomicInteger(3), exception))) | ||
| .isInstanceOf(exception.getClass()) | ||
| .hasMessage(exception.getMessage()); | ||
| } | ||
|
|
||
| private static Stream<Arguments> retryableExceptions() { | ||
| return Stream.of( | ||
| Arguments.of( | ||
| new SocketTimeoutException("socket timeout exception"), | ||
| new SSLException("some ssl exception"))); | ||
| } | ||
|
|
||
| private static Stream<Arguments> nonRetryableExceptions() { | ||
| return Stream.of(Arguments.of(new IOException("some generic non-retryable IO exception"))); | ||
| } | ||
|
|
||
| private S3ClientWrapper flakyStreamClient(AtomicInteger counter, IOException failure) { | ||
| S3ClientWrapper flakyClient = spy(new S3ClientWrapper(s3Client())); | ||
| doAnswer(invocation -> new FlakyInputStream(invocation.callRealMethod(), counter, failure)) | ||
| .when(flakyClient) | ||
| .getObject(any(GetObjectRequest.class), any(ResponseTransformer.class)); | ||
| return flakyClient; | ||
| } | ||
|
|
||
| /** Wrapper for S3 client, used to mock the final class DefaultS3Client */ | ||
| public static class S3ClientWrapper implements S3Client { | ||
|
|
||
| private final S3Client delegate; | ||
|
|
||
| public S3ClientWrapper(S3Client delegate) { | ||
| this.delegate = delegate; | ||
| } | ||
|
|
||
| @Override | ||
| public String serviceName() { | ||
| return delegate.serviceName(); | ||
| } | ||
|
|
||
| @Override | ||
| public void close() { | ||
| delegate.close(); | ||
| } | ||
|
|
||
| @Override | ||
| public <ReturnT> ReturnT getObject( | ||
| GetObjectRequest getObjectRequest, | ||
| ResponseTransformer<GetObjectResponse, ReturnT> responseTransformer) | ||
| throws AwsServiceException, SdkClientException { | ||
| return delegate.getObject(getObjectRequest, responseTransformer); | ||
| } | ||
|
|
||
| @Override | ||
| public HeadObjectResponse headObject(HeadObjectRequest headObjectRequest) | ||
| throws AwsServiceException, SdkClientException { | ||
| return delegate.headObject(headObjectRequest); | ||
| } | ||
|
|
||
| @Override | ||
| public PutObjectResponse putObject(PutObjectRequest putObjectRequest, RequestBody requestBody) | ||
| throws AwsServiceException, SdkClientException { | ||
| return delegate.putObject(putObjectRequest, requestBody); | ||
| } | ||
|
|
||
| @Override | ||
| public CreateBucketResponse createBucket(CreateBucketRequest createBucketRequest) | ||
| throws AwsServiceException, SdkClientException { | ||
| return delegate.createBucket(createBucketRequest); | ||
| } | ||
| } | ||
|
|
||
| static class FlakyInputStream extends InputStream { | ||
| private final ResponseInputStream<GetObjectResponse> delegate; | ||
| private final AtomicInteger counter; | ||
| private final int round; | ||
| private final IOException exception; | ||
|
|
||
| FlakyInputStream(Object invocationResponse, AtomicInteger counter, IOException exception) { | ||
| this.delegate = (ResponseInputStream<GetObjectResponse>) invocationResponse; | ||
| this.counter = counter; | ||
| this.round = counter.get(); | ||
| this.exception = exception; | ||
| } | ||
|
|
||
| private void checkCounter() throws IOException { | ||
| // for every round of n invocations, only the last call succeeds | ||
| if (counter.decrementAndGet() == 0) { | ||
| counter.set(round); | ||
| } else { | ||
| throw exception; | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public int read() throws IOException { | ||
| checkCounter(); | ||
| return delegate.read(); | ||
| } | ||
|
|
||
| @Override | ||
| public int read(byte[] b) throws IOException { | ||
| checkCounter(); | ||
| return delegate.read(b); | ||
| } | ||
|
|
||
| @Override | ||
| public int read(byte[] b, int off, int len) throws IOException { | ||
| checkCounter(); | ||
| return delegate.read(b, off, len); | ||
| } | ||
|
|
||
| @Override | ||
| public void close() throws IOException { | ||
| delegate.close(); | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.