Keep Record of Original Exception in S3 Callbacks

src/main/java/software/amazon/awssdk/crt/CrtRuntimeException.java

@@ -63,6 +63,17 @@ public CrtRuntimeException(int errorCode) {
         this.errorName = CRT.awsErrorName(errorCode);
     }
 
+    /**
+     * Constructor for Crt exceptions due to native errors with a cause.
+     * @param errorCode native error code detailing the reason for the exception
+     * @param cause cause of the exception such as a Java exception in a callback
+     */
+    public CrtRuntimeException(int errorCode, Throwable cause) {
+        super(CRT.awsErrorString(errorCode), cause);
+        this.errorCode = errorCode;
+        this.errorName = CRT.awsErrorName(errorCode);
+    }
+
     @Override
     public String toString() {
         return String.format("%s %s(%d)", super.toString(), errorName, errorCode);

src/main/java/software/amazon/awssdk/crt/s3/CrtS3RuntimeException.java

@@ -47,6 +47,23 @@ public CrtS3RuntimeException(int errorCode, int responseStatus, byte[] errorPayl
         this.awsErrorMessage = GetElementFromPayload(this.errorPayload, messageBeginBlock, messageEndBlock);
     }
 
+
+    /**
+     * Helper function to create a runtime exception from S3 response and a cause.
+     * @param errorCode The CRT error code
+     * @param responseStatus statusCode of the HTTP response
+     * @param errorPayload  body of the error response
+     * @param cause cause of the exception such as a Java exception in a callback
+     */
+    public CrtS3RuntimeException(int errorCode, int responseStatus, byte[] errorPayload, Throwable cause) {
+        super(errorCode, cause);
+        String errorString = new String(errorPayload, java.nio.charset.StandardCharsets.UTF_8);
+        this.statusCode = responseStatus;
+        this.errorPayload = errorString;
+        this.awsErrorCode = GetElementFromPayload(this.errorPayload, codeBeginBlock, codeEndBlock);
+        this.awsErrorMessage = GetElementFromPayload(this.errorPayload, messageBeginBlock, messageEndBlock);
+    }
+
     /**
      * Helper function to get the detail of an element from xml payload. If not
      * found, empty string will be returned.

src/main/java/software/amazon/awssdk/crt/s3/S3FinishedResponseContext.java

@@ -11,48 +11,61 @@ public class S3FinishedResponseContext {
     private final ChecksumAlgorithm checksumAlgorithm;
     private final boolean didValidateChecksum;
 
+    private CrtS3RuntimeException exception;
+
     /*
      * errorCode The CRT error code
      * responseStatus statusCode of the HTTP response
      * errorPayload body of the error response. Can be null if the request completed successfully
      * checksumAlgorithm, the algorithm used to validate the Body, None if not validated
      * didValidateChecksum which is true if the response was validated.
      */
-    S3FinishedResponseContext(final int errorCode, final int responseStatus, final byte[] errorPayload, final ChecksumAlgorithm checksumAlgorithm, final boolean didValidateChecksum) {
+    S3FinishedResponseContext(final int errorCode, final int responseStatus, final byte[] errorPayload, final ChecksumAlgorithm checksumAlgorithm, final boolean didValidateChecksum, Throwable cause) {
         this.errorCode = errorCode;
         this.responseStatus = responseStatus;
         this.errorPayload = errorPayload;
         this.checksumAlgorithm = checksumAlgorithm;
         this.didValidateChecksum = didValidateChecksum;
+        if (cause != null) {
+            this.exception = new CrtS3RuntimeException(errorCode, responseStatus, errorPayload, cause);
+        } else if (errorCode != 0) {
+            this.exception = new CrtS3RuntimeException(errorCode, responseStatus, errorPayload);
+        }
     }
 
-    public int getErrorCode () {
+    public int getErrorCode() {
         return this.errorCode;
     }
 
     /*
      * If the request didn't receive a response due to a connection
      * failure or some other issue the response status will be 0.
      */
-    public int getResponseStatus () {
+    public int getResponseStatus() {
         return this.responseStatus;
     }
 
     /*
      * In the case of a failed http response get the payload of the response.
      */
-    public byte[] getErrorPayload () {
+    public byte[] getErrorPayload() {
         return this.errorPayload;
     }
 
     /*
      * if no checksum is found, or the request finished with an error the Algorithm will be None,
      * otherwise the algorithm will correspond to the one attached to the object when uploaded.
      */
-    public ChecksumAlgorithm getChecksumAlgorithm () {
+    public ChecksumAlgorithm getChecksumAlgorithm() {
         return this.checksumAlgorithm;
     }
-    public boolean isChecksumValidated () {
+
+    public boolean isChecksumValidated() {
         return this.didValidateChecksum;
     }
+
+    public CrtS3RuntimeException getException() {
+        return exception;
+    }
+
 }

src/main/java/software/amazon/awssdk/crt/s3/S3MetaRequestResponseHandlerNativeAdapter.java

@@ -19,8 +19,8 @@ int onResponseBody(byte[] bodyBytesIn, long objectRangeStart, long objectRangeEn
         return this.responseHandler.onResponseBody(ByteBuffer.wrap(bodyBytesIn), objectRangeStart, objectRangeEnd);
     }
 
-    void onFinished(int errorCode, int responseStatus, byte[] errorPayload, int checksumAlgorithm, boolean didValidateChecksum) {
-        S3FinishedResponseContext context = new S3FinishedResponseContext(errorCode, responseStatus, errorPayload, ChecksumAlgorithm.getEnumValueFromInteger(checksumAlgorithm), didValidateChecksum);
+    void onFinished(int errorCode, int responseStatus, byte[] errorPayload, int checksumAlgorithm, boolean didValidateChecksum, Throwable cause) {
+        S3FinishedResponseContext context = new S3FinishedResponseContext(errorCode, responseStatus, errorPayload, ChecksumAlgorithm.getEnumValueFromInteger(checksumAlgorithm), didValidateChecksum, cause);
         this.responseHandler.onFinished(context);
     }
 

src/native/crt.c

@@ -286,6 +286,18 @@ bool aws_jni_check_and_clear_exception(JNIEnv *env) {
     return exception_pending;
 }
 
+bool aws_jni_get_and_clear_exception(JNIEnv *env, jthrowable *out) {
+    bool exception_pending = (*env)->ExceptionCheck(env);
+    if (exception_pending) {
+        (*env)->DeleteGlobalRef(env, *out);
+        if (out != NULL) {
+            *out = (jthrowable)(*env)->NewGlobalRef(env, (*env)->ExceptionOccurred(env));
+        }
+        (*env)->ExceptionClear(env);
+    }
+    return exception_pending;
+}
+
 int aws_size_t_from_java(JNIEnv *env, size_t *out_size, jlong java_long, const char *errmsg_prefix) {
     if (java_long < 0) {
         aws_jni_throw_illegal_argument_exception(env, "%s cannot be negative", errmsg_prefix);

src/native/crt.h

@@ -59,6 +59,21 @@ void aws_jni_throw_illegal_argument_exception(JNIEnv *env, const char *msg, ...)
  ******************************************************************************/
 bool aws_jni_check_and_clear_exception(JNIEnv *env);
 
+/*******************************************************************************
+ * Checks whether or not an exception is pending on the stack.
+ * If the exception is pending, deletes existing global reference of `out`, sets `out` to the new exception and clears
+ * it.
+ *
+ * @param env A pointer to the JNI environment, used to interact with the JVM.
+ * @param out A pointer to a jthrowable object. If an exception is pending, the function
+ *            deletes any existing global reference pointed to by 'out', and sets 'out'
+ *            to point to the new exception.
+ *
+ * @return true if an exception was pending and has been cleared; false otherwise.
+ *
+ ******************************************************************************/
+bool aws_jni_get_and_clear_exception(JNIEnv *env, jthrowable *out);
+
 /*******************************************************************************
  * Set a size_t based on a jlong.
  * If conversion fails, a java IllegalArgumentException is thrown like

src/native/java_class_ids.c

@@ -693,7 +693,7 @@ static void s_cache_s3_meta_request_response_handler_native_adapter_properties(J
     AWS_FATAL_ASSERT(s3_meta_request_response_handler_native_adapter_properties.onResponseBody);
 
     s3_meta_request_response_handler_native_adapter_properties.onFinished =
-        (*env)->GetMethodID(env, cls, "onFinished", "(II[BIZ)V");
+        (*env)->GetMethodID(env, cls, "onFinished", "(II[BIZLjava/lang/Throwable;)V");
     AWS_FATAL_ASSERT(s3_meta_request_response_handler_native_adapter_properties.onFinished);
 
     s3_meta_request_response_handler_native_adapter_properties.onResponseHeaders =

src/native/s3_client.c

@@ -46,6 +46,7 @@ struct s3_client_make_meta_request_callback_data {
     jobject java_s3_meta_request_response_handler_native_adapter;
     struct aws_input_stream *input_stream;
     struct aws_signing_config_data signing_config_data;
+    jthrowable java_exception;
 };
 
 static void s_on_s3_client_shutdown_complete_callback(void *user_data);
@@ -354,7 +355,7 @@ static int s_on_s3_meta_request_body_callback(
             range_start,
             range_end);
 
-        if (aws_jni_check_and_clear_exception(env)) {
+        if (aws_jni_get_and_clear_exception(env, &(callback_data->java_exception))) {
             AWS_LOGF_ERROR(
                 AWS_LS_S3_META_REQUEST,
                 "id=%p: Ignored Exception from S3MetaRequest.onResponseBody callback",
@@ -432,7 +433,7 @@ static int s_on_s3_meta_request_headers_callback(
             response_status,
             java_headers_buffer);
 
-        if (aws_jni_check_and_clear_exception(env)) {
+        if (aws_jni_get_and_clear_exception(env, &(callback_data->java_exception))) {
             AWS_LOGF_ERROR(
                 AWS_LS_S3_META_REQUEST,
                 "id=%p: Exception thrown from S3MetaRequest.onResponseHeaders callback",
@@ -489,7 +490,8 @@ static void s_on_s3_meta_request_finish_callback(
             meta_request_result->response_status,
             jni_payload,
             meta_request_result->validation_algorithm,
-            meta_request_result->did_validate);
+            meta_request_result->did_validate,
+            callback_data->java_exception);
 
         if (aws_jni_check_and_clear_exception(env)) {
             AWS_LOGF_ERROR(
@@ -571,6 +573,7 @@ static void s_s3_meta_request_callback_cleanup(
     if (callback_data) {
         (*env)->DeleteGlobalRef(env, callback_data->java_s3_meta_request);
         (*env)->DeleteGlobalRef(env, callback_data->java_s3_meta_request_response_handler_native_adapter);
+        (*env)->DeleteGlobalRef(env, callback_data->java_exception);
         aws_signing_config_data_clean_up(&callback_data->signing_config_data, env);
         aws_mem_release(aws_jni_get_allocator(), callback_data);
     }

src/test/java/software/amazon/awssdk/crt/test/S3ClientTest.java

@@ -271,7 +271,6 @@ public void testS3Get() {
         skipIfAndroid();
         skipIfNetworkUnavailable();
         Assume.assumeTrue(hasAwsCredentials());
-
         S3ClientOptions clientOptions = new S3ClientOptions().withRegion(REGION);
         try (S3Client client = createS3Client(clientOptions)) {
             CompletableFuture<Integer> onFinishedFuture = new CompletableFuture<>();
@@ -290,9 +289,7 @@ public void onFinished(S3FinishedResponseContext context) {
                     Log.log(Log.LogLevel.Info, Log.LogSubject.JavaCrtS3,
                             "Meta request finished with error code " + context.getErrorCode());
                     if (context.getErrorCode() != 0) {
-                        onFinishedFuture.completeExceptionally(
-                                new CrtS3RuntimeException(context.getErrorCode(), context.getResponseStatus(),
-                                        context.getErrorPayload()));
+                        onFinishedFuture.completeExceptionally(context.getException());
                         return;
                     }
                     onFinishedFuture.complete(Integer.valueOf(context.getErrorCode()));
@@ -314,6 +311,59 @@ public void onFinished(S3FinishedResponseContext context) {
         }
     }
 
+    @Test
+    public void testS3CallbackExceptionIsProperlyPropagated() {
+        skipIfAndroid();
+        skipIfNetworkUnavailable();
+        Assume.assumeTrue(hasAwsCredentials());
+        S3ClientOptions clientOptions = new S3ClientOptions().withRegion(REGION);
+        RuntimeException expectedException = new RuntimeException("Exception From a Java Function");
+        boolean foundExpectedException = false;
+
+        try (S3Client client = createS3Client(clientOptions)) {
+            CompletableFuture<Integer> onFinishedFuture = new CompletableFuture<>();
+            S3MetaRequestResponseHandler responseHandler = new S3MetaRequestResponseHandler() {
+
+                @Override
+                public int onResponseBody(ByteBuffer bodyBytesIn, long objectRangeStart, long objectRangeEnd) {
+                    throw expectedException;
+                }
+
+                @Override
+                public void onFinished(S3FinishedResponseContext context) {
+                    Log.log(Log.LogLevel.Info, Log.LogSubject.JavaCrtS3,
+                            "Meta request finished with error code " + context.getErrorCode());
+                    if (context.getErrorCode() != 0) {
+                        onFinishedFuture.completeExceptionally(context.getException());
+                        return;
+                    }
+                    onFinishedFuture.complete(Integer.valueOf(context.getErrorCode()));
+                }
+            };
+
+            HttpHeader[] headers = { new HttpHeader("Host", ENDPOINT) };
+            HttpRequest httpRequest = new HttpRequest("GET", "/get_object_test_1MB.txt", headers, null);
+
+            S3MetaRequestOptions metaRequestOptions = new S3MetaRequestOptions()
+                    .withMetaRequestType(MetaRequestType.GET_OBJECT).withHttpRequest(httpRequest)
+                    .withResponseHandler(responseHandler);
+
+            try (S3MetaRequest metaRequest = client.makeMetaRequest(metaRequestOptions)) {
+                Assert.assertEquals(Integer.valueOf(0), onFinishedFuture.get());
+            }
+        } catch (InterruptedException | ExecutionException ex) {
+            Throwable cause = ex.getCause();
+            while (cause != null) {
+                if (cause == expectedException) {
+                    foundExpectedException = true;
+                    break;
+                }
+                cause = cause.getCause();
+            }
+        }
+        Assert.assertTrue("Expected exception not found in the cause chain", foundExpectedException);
+    }
+
     @Test
     public void testS3GetWithEndpoint() {
         skipIfAndroid();