Manage S3Exception in exception handling

Author: jreynard-code

api/src/integrationTest/kotlin/com/cosmotech/api/home/workspace/WorkspaceControllerTests.kt

@@ -692,7 +692,7 @@ class WorkspaceControllerTests : ControllerTestBase() {
                 .param("file_name", "Wrong file name")
                 .accept(MediaType.APPLICATION_OCTET_STREAM))
         .andExpect(status().is4xxClientError)
-        .andExpect(jsonPath("$.detail").value("The specified key does not exist."))
+        .andExpect(jsonPath("$.detail").value("Wrong file name does not exist."))
         .andDo(MockMvcResultHandlers.print())
   }
 }

common/src/main/kotlin/com/cosmotech/common/exceptions/CsmExceptionHandling.kt

@@ -2,6 +2,7 @@
 // Licensed under the MIT license.
 package com.cosmotech.common.exceptions
 
+import io.awspring.cloud.s3.S3Exception
 import java.net.URI
 import org.apache.commons.lang3.NotImplementedException
 import org.springframework.core.Ordered
@@ -23,6 +24,7 @@ import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExcep
 import org.springframework.web.util.BindErrorUtils
 import software.amazon.awssdk.services.s3.model.NoSuchKeyException
 
+@Suppress("TooManyFunctions")
 @Order(Ordered.HIGHEST_PRECEDENCE)
 @RestControllerAdvice
 open class CsmExceptionHandling : ResponseEntityExceptionHandler() {
@@ -165,9 +167,20 @@ open class CsmExceptionHandling : ResponseEntityExceptionHandler() {
   @ExceptionHandler(NoSuchKeyException::class)
   fun handleNoSuchKeyException(): ProblemDetail {
     val response = ProblemDetail.forStatus(HttpStatus.NOT_FOUND)
-    val notImplementedErrorStatus = HttpStatus.NOT_FOUND
-    response.type = URI.create(httpStatusCodeTypePrefix + notImplementedErrorStatus.value())
+    val noSuchKeyErrorStatus = HttpStatus.NOT_FOUND
+    response.type = URI.create(httpStatusCodeTypePrefix + noSuchKeyErrorStatus.value())
     response.detail = "The specified file name does not exist."
     return response
   }
+
+  @ExceptionHandler(S3Exception::class)
+  fun handleS3Exception(exception: S3Exception): ProblemDetail {
+    val response = ProblemDetail.forStatus(HttpStatus.INTERNAL_SERVER_ERROR)
+    val internalServerErrorStatus = HttpStatus.INTERNAL_SERVER_ERROR
+    response.type = URI.create(httpStatusCodeTypePrefix + internalServerErrorStatus.value())
+    if (exception.message != null) {
+      response.detail = exception.message
+    }
+    return response
+  }
 }

workspace/src/integrationTest/kotlin/com/cosmotech/workspace/service/WorkspaceServiceIntegrationTest.kt

@@ -48,7 +48,6 @@ import org.springframework.mock.web.MockMultipartFile
 import org.springframework.test.context.ActiveProfiles
 import org.springframework.test.context.junit.jupiter.SpringExtension
 import org.springframework.test.context.junit4.SpringRunner
-import software.amazon.awssdk.services.s3.model.NoSuchKeyException
 
 @ActiveProfiles(profiles = ["workspace-test"])
 @ExtendWith(MockKExtension::class)
@@ -188,11 +187,11 @@ class WorkspaceServiceIntegrationTest : CsmTestBase() {
         organizationSaved.id, workspaceSaved.id, multipartFile, true, null)
 
     val exception =
-        assertThrows<NoSuchKeyException> {
+        assertThrows<CsmResourceNotFoundException> {
           workspaceApiService.getWorkspaceFile(organizationSaved.id, workspaceSaved.id, "WrongName")
         }
 
-    assertEquals("The specified key does not exist.", exception.awsErrorDetails().errorMessage())
+    assertEquals("WrongName does not exist.", exception.message)
   }
 
   @Test

workspace/src/main/kotlin/com/cosmotech/workspace/service/WorkspaceServiceImpl.kt

@@ -335,13 +335,23 @@ internal class WorkspaceServiceImpl(
             .prefix(prefix)
             .build()
 
-    return s3Client
-        .listObjectsV2Paginator(listObjectsRequest)
-        .stream()
-        .flatMap {
-          it.contents().stream().map { WorkspaceFile(fileName = it.key().removePrefix(prefix)) }
-        }
-        .toList()
+    try {
+      return s3Client
+          .listObjectsV2Paginator(listObjectsRequest)
+          .stream()
+          .flatMap { s3Object ->
+            s3Object.contents().stream().map {
+              WorkspaceFile(fileName = it.key().removePrefix(prefix))
+            }
+          }
+          .toList()
+    } catch (e: AwsServiceException) {
+      throw S3Exception("Something wrong happened when listing workspace files", e)
+    } catch (e: SdkClientException) {
+      throw S3Exception("Something wrong happened when listing workspace files", e)
+    } catch (e: S3Exception) {
+      throw S3Exception("Something wrong happened when listing workspace files", e)
+    }
   }
 
   private fun deleteS3WorkspaceObject(