refactor exception handling isolate NotFound exception to the Storage service

Author: phantumcode

aws-storage-s3/src/main/java/com/amplifyframework/storage/s3/operation/AWSS3StorageGetPresignedUrlOperation.java

@@ -30,8 +30,6 @@
 import java.net.URL;
 import java.util.concurrent.ExecutorService;
 
-import aws.sdk.kotlin.services.s3.model.NotFound;
-
 /**
  * An operation to retrieve pre-signed object URL from AWS S3.
  *
@@ -92,19 +90,8 @@ public void start() {
                                 if (getRequest().validateObjectExistence()) {
                                     try {
                                         storageService.validateObjectExists(serviceKey);
-                                    } catch (NotFound nfe) {
-                                        onError.accept(new StorageException(
-                                                "Unable to generate URL for non-existent path: $serviceKey",
-                                                nfe,
-                                                "Please ensure the path is valid or the object has been uploaded."
-                                        ));
-                                        return;
-                                    } catch (Exception exception) {
-                                        onError.accept(new StorageException(
-                                                "Encountered an issue while validating the existence of object",
-                                                exception,
-                                                "See included exception for more details and suggestions to fix."
-                                        ));
+                                    } catch (StorageException exception) {
+                                        onError.accept(exception);
                                         return;
                                     }
                                 }
@@ -116,13 +103,14 @@ public void start() {
                                 onSuccess.accept(StorageGetUrlResult.fromUrl(url));
                             } catch (Exception exception) {
                                 onError.accept(new StorageException(
-                                        "Encountered an issue while generating pre-signed URL",
-                                        exception,
-                                        "See included exception for more details and suggestions to fix."
+                                    "Encountered an issue while generating pre-signed URL",
+                                    exception,
+                                    "See included exception for more details and suggestions to fix."
                                 ));
                             }
 
-                        }, onError);
+                        },
+                        onError);
             }
         );
     }

aws-storage-s3/src/main/java/com/amplifyframework/storage/s3/operation/AWSS3StoragePathGetPresignedUrlOperation.kt

@@ -14,7 +14,6 @@
  */
 package com.amplifyframework.storage.s3.operation
 
-import aws.sdk.kotlin.services.s3.model.NotFound
 import com.amplifyframework.auth.AuthCredentialsProvider
 import com.amplifyframework.core.Consumer
 import com.amplifyframework.storage.StorageException
@@ -52,14 +51,8 @@ internal class AWSS3StoragePathGetPresignedUrlOperation(
             if (request.validateObjectExistence) {
                 try {
                     storageService.validateObjectExists(serviceKey)
-                } catch (nfe: NotFound) {
-                    onError.accept(
-                        StorageException(
-                            "Unable to generate URL for non-existent path: $serviceKey",
-                            nfe,
-                            "Please ensure the path is valid or the object has been uploaded."
-                        )
-                    )
+                } catch (se: StorageException) {
+                    onError.accept(se)
                     return@submit
                 } catch (exception: Exception) {
                     onError.accept(

aws-storage-s3/src/main/java/com/amplifyframework/storage/s3/service/AWSS3StorageService.kt

@@ -21,11 +21,13 @@ import aws.sdk.kotlin.services.s3.deleteObject
 import aws.sdk.kotlin.services.s3.listObjectsV2
 import aws.sdk.kotlin.services.s3.model.GetObjectRequest
 import aws.sdk.kotlin.services.s3.model.HeadObjectRequest
+import aws.sdk.kotlin.services.s3.model.NotFound
 import aws.sdk.kotlin.services.s3.paginators.listObjectsV2Paginated
 import aws.sdk.kotlin.services.s3.presigners.presignGetObject
 import aws.sdk.kotlin.services.s3.withConfig
 import com.amplifyframework.auth.AuthCredentialsProvider
 import com.amplifyframework.storage.ObjectMetadata
+import com.amplifyframework.storage.StorageException
 import com.amplifyframework.storage.StorageItem
 import com.amplifyframework.storage.result.StorageListResult
 import com.amplifyframework.storage.s3.transfer.TransferManager
@@ -92,12 +94,20 @@ internal class AWSS3StorageService(
      * @param serviceKey S3 service key
      */
     override fun validateObjectExists(serviceKey: String) {
-        runBlocking {
-            s3Client.headObject(
-                HeadObjectRequest {
-                    bucket = s3BucketName
-                    key = serviceKey
-                }
+        try {
+            runBlocking {
+                s3Client.headObject(
+                    HeadObjectRequest {
+                        bucket = s3BucketName
+                        key = serviceKey
+                    }
+                )
+            }
+        } catch (ex: NotFound) {
+            throw StorageException(
+                "Unable to generate URL for non-existent path: $serviceKey",
+                ex,
+                "Please ensure the path is valid or the object has been uploaded"
             )
         }
     }

aws-storage-s3/src/main/java/com/amplifyframework/storage/s3/service/StorageService.java

@@ -20,6 +20,7 @@
 import androidx.annotation.Nullable;
 
 import com.amplifyframework.storage.ObjectMetadata;
+import com.amplifyframework.storage.StorageException;
 import com.amplifyframework.storage.StorageItem;
 import com.amplifyframework.storage.result.StorageListResult;
 import com.amplifyframework.storage.s3.transfer.TransferObserver;
@@ -41,8 +42,9 @@ public interface StorageService {
      * Throws StorageException if object is not does not exist.
      *
      * @param serviceKey key to uniquely specify item to generate URL for
+     * @throws StorageException If object does not exist in storage
      */
-    void validateObjectExists(@NonNull String serviceKey);
+    void validateObjectExists(@NonNull String serviceKey) throws StorageException;
 
     /**
      * Generate pre-signed download URL for an object.

aws-storage-s3/src/test/java/com/amplifyframework/storage/s3/operation/AWSS3StorageGetPresignedUrlOperationTest.kt

@@ -15,7 +15,6 @@
 package com.amplifyframework.storage.s3.operation
 
 import android.util.Log
-import aws.sdk.kotlin.services.s3.model.NotFound
 import com.amplifyframework.auth.AuthCredentialsProvider
 import com.amplifyframework.core.Consumer
 import com.amplifyframework.storage.StorageAccessLevel
@@ -153,7 +152,7 @@ public class AWSS3StorageGetPresignedUrlOperationTest {
             false,
             true
         )
-        val expectedException = NotFound({})
+        val expectedException = StorageException("Test", "Test")
         storageService = mockk<StorageService>(relaxed = true)
         coEvery { storageService.validateObjectExists(any()) } throws expectedException
         coEvery { authCredentialsProvider.getIdentityId() } returns "abc"
@@ -172,7 +171,7 @@ public class AWSS3StorageGetPresignedUrlOperationTest {
         awsS3StorageGetPresignedUrlOperation.start()
 
         // THEN
-        verify(exactly = 1) { onError.accept(any()) }
+        verify(exactly = 1) { onError.accept(expectedException) }
         verify(exactly = 0) {
             storageService.getPresignedUrl(any(), any(), any())
         }

aws-storage-s3/src/test/java/com/amplifyframework/storage/s3/operation/AWSS3StoragePathGetUrlOperationTest.kt

@@ -15,7 +15,6 @@
 
 package com.amplifyframework.storage.s3.operation
 
-import aws.sdk.kotlin.services.s3.model.NotFound
 import com.amplifyframework.auth.AuthCredentialsProvider
 import com.amplifyframework.core.Consumer
 import com.amplifyframework.storage.StorageException
@@ -222,7 +221,7 @@ class AWSS3StoragePathGetUrlOperationTest {
     fun `getPresignedUrl fails with non existent S3 path when validateObjectExistence is enabled`() {
         // GIVEN
         val path = StoragePath.fromString("public/123")
-        val expectedException = NotFound({})
+        val expectedException = StorageException("Test", "Test")
         coEvery { storageService.validateObjectExists(any()) } throws expectedException
         val request = AWSS3StoragePathGetPresignedUrlRequest(
             path,
@@ -244,7 +243,7 @@ class AWSS3StoragePathGetUrlOperationTest {
         awsS3StorageGetPresignedUrlOperation.start()
 
         // THEN
-        verify(exactly = 1) { onError.accept(any()) }
+        verify(exactly = 1) { onError.accept(expectedException) }
         verify(exactly = 0) {
             storageService.getPresignedUrl(any(), any(), any())
         }