chore(controllers): Return 404 and json content when objects are not …

…found. (#123)

kayenta-core/src/main/java/com/netflix/kayenta/storage/StorageService.java

@@ -16,12 +16,14 @@
 
 package com.netflix.kayenta.storage;
 
+import com.netflix.spinnaker.kork.web.exceptions.NotFoundException;
+
 import java.util.List;
 import java.util.Map;
 
 public interface StorageService {
   boolean servicesAccount(String accountName);
-  <T> T loadObject(String accountName, ObjectType objectType, String objectKey) throws IllegalArgumentException;
+  <T> T loadObject(String accountName, ObjectType objectType, String objectKey) throws IllegalArgumentException, NotFoundException;
   <T> void storeObject(String accountName, ObjectType objectType, String objectKey, T obj, String filename, boolean isAnUpdate);
   void deleteObject(String accountName, ObjectType objectType, String objectKey);
   List<Map<String, Object>> listObjectKeys(String accountName, ObjectType objectType, List<String> applications, boolean skipIndex);

kayenta-gcs/src/main/java/com/netflix/kayenta/gcs/storage/GcsStorageService.java

@@ -34,6 +34,7 @@
 import com.netflix.kayenta.security.AccountCredentialsRepository;
 import com.netflix.kayenta.storage.ObjectType;
 import com.netflix.kayenta.storage.StorageService;
+import com.netflix.spinnaker.kork.web.exceptions.NotFoundException;
 import lombok.Builder;
 import lombok.Getter;
 import lombok.Singular;
@@ -114,13 +115,19 @@ public void ensureBucketExists(String accountName) {
   }
 
   @Override
-  public <T> T loadObject(String accountName, ObjectType objectType, String objectKey) throws IllegalArgumentException {
+  public <T> T loadObject(String accountName, ObjectType objectType, String objectKey) throws IllegalArgumentException, NotFoundException {
     GoogleNamedAccountCredentials credentials = (GoogleNamedAccountCredentials)accountCredentialsRepository
       .getOne(accountName)
       .orElseThrow(() -> new IllegalArgumentException("Unable to resolve account " + accountName + "."));
     Storage storage = credentials.getStorage();
     String bucketName = credentials.getBucket();
-    StorageObject item = resolveSingularItem(objectType, objectKey, credentials, storage, bucketName);
+    StorageObject item;
+
+    try {
+      item = resolveSingularItem(objectType, objectKey, credentials, storage, bucketName);
+    } catch (IllegalArgumentException e) {
+      throw new NotFoundException(e.getMessage());
+    }
 
     try {
       StorageObject storageObject = storage.objects().get(bucketName, item.getName()).execute();
@@ -131,7 +138,7 @@ public <T> T loadObject(String accountName, ObjectType objectType, String object
         HttpResponseException hre = (HttpResponseException)e;
         log.error("Failed to load {} {}: {} {}", objectType.getGroup(), objectKey, hre.getStatusCode(), hre.getStatusMessage());
         if (hre.getStatusCode() == 404) {
-          throw new IllegalArgumentException("No file at path " + item.getName() + ".");
+          throw new NotFoundException("No file at path " + item.getName() + ".");
         }
       }
       throw new IllegalStateException(e);

kayenta-objectstore-configbin/src/main/java/com/netflix/kayenta/configbin/storage/ConfigBinStorageService.java

@@ -29,6 +29,7 @@
 import com.netflix.kayenta.security.AccountCredentialsRepository;
 import com.netflix.kayenta.storage.ObjectType;
 import com.netflix.kayenta.storage.StorageService;
+import com.netflix.spinnaker.kork.web.exceptions.NotFoundException;
 import com.squareup.okhttp.MediaType;
 import com.squareup.okhttp.RequestBody;
 import lombok.Builder;
@@ -69,7 +70,7 @@ public boolean servicesAccount(String accountName) {
   }
 
   @Override
-  public <T> T loadObject(String accountName, ObjectType objectType, String objectKey) throws IllegalArgumentException {
+  public <T> T loadObject(String accountName, ObjectType objectType, String objectKey) throws IllegalArgumentException, NotFoundException {
     ConfigBinNamedAccountCredentials credentials = (ConfigBinNamedAccountCredentials)accountCredentialsRepository
       .getOne(accountName)
       .orElseThrow(() -> new IllegalArgumentException("Unable to resolve account " + accountName + "."));
@@ -81,7 +82,7 @@ public <T> T loadObject(String accountName, ObjectType objectType, String object
     try {
        json = remoteService.get(ownerApp, configType, objectKey);
     } catch (RetrofitError e) {
-      throw new IllegalArgumentException("No such object named " + objectKey);
+      throw new NotFoundException("No such object named " + objectKey);
     }
 
     try {

kayenta-objectstore-memory/src/main/java/com/netflix/kayenta/memory/storage/MemoryStorageService.java

@@ -22,6 +22,7 @@
 import com.netflix.kayenta.security.AccountCredentialsRepository;
 import com.netflix.kayenta.storage.ObjectType;
 import com.netflix.kayenta.storage.StorageService;
+import com.netflix.spinnaker.kork.web.exceptions.NotFoundException;
 import lombok.Builder;
 import lombok.Getter;
 import lombok.Singular;
@@ -65,7 +66,7 @@ public <T> T loadObject(String accountName, ObjectType objectType, String object
     Object entry = credentials.getObjects().get(objectType).get(objectKey);
 
     if (entry == null) {
-      throw new IllegalArgumentException("No such object named " + objectKey);
+      throw new NotFoundException("No such object named " + objectKey);
     }
 
     return (T)entry;

kayenta-s3/src/main/java/com/netflix/kayenta/s3/storage/S3StorageService.java

@@ -31,6 +31,7 @@
 import com.netflix.kayenta.security.AccountCredentialsRepository;
 import com.netflix.kayenta.storage.ObjectType;
 import com.netflix.kayenta.storage.StorageService;
+import com.netflix.spinnaker.kork.web.exceptions.NotFoundException;
 import lombok.Builder;
 import lombok.Getter;
 import lombok.Singular;
@@ -101,13 +102,19 @@ public void ensureBucketExists(String accountName) {
   }
 
   @Override
-  public <T> T loadObject(String accountName, ObjectType objectType, String objectKey) throws IllegalArgumentException {
+  public <T> T loadObject(String accountName, ObjectType objectType, String objectKey) throws IllegalArgumentException, NotFoundException {
     AwsNamedAccountCredentials credentials = (AwsNamedAccountCredentials)accountCredentialsRepository
       .getOne(accountName)
       .orElseThrow(() -> new IllegalArgumentException("Unable to resolve account " + accountName + "."));
     AmazonS3 amazonS3 = credentials.getAmazonS3();
     String bucket = credentials.getBucket();
-    String path = resolveSingularPath(objectType, objectKey, credentials, amazonS3, bucket);
+    String path;
+
+    try {
+      path = resolveSingularPath(objectType, objectKey, credentials, amazonS3, bucket);
+    } catch (IllegalArgumentException e) {
+      throw new NotFoundException(e.getMessage());
+    }
 
     try {
       S3Object s3Object = amazonS3.getObject(bucket, path);
@@ -116,7 +123,7 @@ public <T> T loadObject(String accountName, ObjectType objectType, String object
     } catch (AmazonS3Exception e) {
       log.error("Failed to load {} {}: {}", objectType.getGroup(), objectKey, e.getStatusCode());
       if (e.getStatusCode() == 404) {
-        throw new IllegalArgumentException("No file at path " + path + ".");
+        throw new NotFoundException("No file at path " + path + ".");
       }
       throw e;
     } catch (IOException e) {

kayenta-web/src/main/java/com/netflix/kayenta/controllers/ControllerExceptionHandler.java

@@ -16,11 +16,15 @@
 
 package com.netflix.kayenta.controllers;
 
+import com.netflix.spinnaker.kork.web.exceptions.NotFoundException;
 import org.springframework.http.HttpStatus;
 import org.springframework.web.bind.annotation.ExceptionHandler;
 import org.springframework.web.bind.annotation.ResponseStatus;
 import org.springframework.web.bind.annotation.RestControllerAdvice;
 
+import java.util.Collections;
+import java.util.Map;
+
 @RestControllerAdvice
 public class ControllerExceptionHandler {
 
@@ -29,4 +33,10 @@ public class ControllerExceptionHandler {
   public String handleException(IllegalArgumentException e) {
     return e.getMessage();
   }
+
+  @ResponseStatus(HttpStatus.NOT_FOUND)
+  @ExceptionHandler(NotFoundException.class)
+  public Map handleException(NotFoundException e) {
+    return Collections.singletonMap("message", e.getMessage());
+  }
 }