[ENHANCEMENT] Improves Error Messaging in Responses

common/exceptions/README.md

@@ -0,0 +1,9 @@
+# Shared Exceptions Code for the Rest API
+
+This package contains shared code that is used to handle exceptions
+from REST requests to mojo frames and back.
+
+
+## Building
+
+This is a standard Java gradle project and is build as usual by `./gradlew build`.

common/exceptions/build.gradle

@@ -0,0 +1,9 @@
+apply from: project(":").file('gradle/java.gradle')
+
+dependencies {
+    implementation group: 'org.slf4j', name: 'slf4j-api'
+}
+
+test {
+    useJUnitPlatform()
+}

common/exceptions/src/main/java/ai/h2o/mojos/deploy/common/exceptions/ScoringException.java

@@ -0,0 +1,12 @@
+package ai.h2o.mojos.deploy.common.exceptions;
+
+public class ScoringException extends RuntimeException {
+
+  public ScoringException(String message) {
+    super(message);
+  }
+
+  public ScoringException(String message, Throwable cause) {
+    super(message, cause);
+  }
+}

common/exceptions/src/main/java/ai/h2o/mojos/deploy/common/exceptions/ScoringShapleyException.java

@@ -0,0 +1,8 @@
+package ai.h2o.mojos.deploy.common.exceptions;
+
+public class ScoringShapleyException extends RuntimeException {
+
+  public ScoringShapleyException(String message, Throwable cause) {
+    super(message, cause);
+  }
+}

common/transform/src/main/java/ai/h2o/mojos/deploy/common/transform/MojoScorer.java

@@ -133,6 +133,7 @@ public ScoreResponse score(ScoreRequest request) {
     } catch (Exception e) {
       log.info("Failed shapley contribution due to: {}", e.getMessage());
       log.debug(" - failure cause: ", e);
+      return response;
     }
     return response;
   }

local-rest-scorer/build.gradle

@@ -5,6 +5,7 @@ plugins {
 apply from: project(":").file('gradle/java.gradle')
 
 dependencies {
+    implementation project(':common:exceptions')
     implementation project(':common:rest-spring-api')
     implementation project(':common:transform')
     implementation group: 'ai.h2o', name: 'h2o-genmodel'

local-rest-scorer/src/main/java/ai/h2o/mojos/deploy/local/rest/controller/ModelsApiController.java

@@ -1,5 +1,7 @@
 package ai.h2o.mojos.deploy.local.rest.controller;
 
+import ai.h2o.mojos.deploy.common.exceptions.ScoringException;
+import ai.h2o.mojos.deploy.common.exceptions.ScoringShapleyException;
 import ai.h2o.mojos.deploy.common.rest.api.ModelApi;
 import ai.h2o.mojos.deploy.common.rest.model.CapabilityType;
 import ai.h2o.mojos.deploy.common.rest.model.ContributionRequest;
@@ -18,7 +20,6 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
 import org.springframework.stereotype.Controller;
 
@@ -72,29 +73,28 @@ public ResponseEntity<ScoreResponse> getScore(ScoreRequest request) {
       ScoreResponse scoreResponse = scorer.score(request);
       return ResponseEntity.ok(scoreResponse);
     } catch (Exception e) {
-      log.info("Failed scoring request: {}, due to: {}", request, e.getMessage());
-      log.debug(" - failure cause: ", e);
-      return ResponseEntity.badRequest().build();
+      String message = String.format(
+          "Failed scoring request: %s, due to: %s", request, e.getMessage());
+      throw new ScoringException(message, e);
     }
   }
 
   @Override
   public ResponseEntity<ScoreResponse> getScoreByFile(String file) {
     if (Strings.isNullOrEmpty(file)) {
-      log.info("Request is missing a valid CSV file path");
-      return ResponseEntity.badRequest().build();
+      throw new ScoringException("Request is missing a valid CSV file path");
     }
     try {
       log.info("Got scoring request for CSV");
       return ResponseEntity.ok(scorer.scoreCsv(file));
     } catch (IOException e) {
-      log.info("Failed loading CSV file: {}, due to: {}", file, e.getMessage());
-      log.debug(" - failure cause: ", e);
-      return ResponseEntity.badRequest().build();
+      String message = String.format(
+          "Failed loading CSV file: %s, due to: %s", file, e.getMessage());
+      throw new ScoringException(message, e);
     } catch (Exception e) {
-      log.info("Failed scoring CSV file: {}, due to: {}", file, e.getMessage());
-      log.debug(" - failure cause: ", e);
-      return ResponseEntity.badRequest().build();
+      String message = String.format(
+          "Failed scoring CSV file: %s, due to: %s", file, e.getMessage());
+      throw new ScoringException(message, e);
     }
   }
 
@@ -106,13 +106,15 @@ public ResponseEntity<ContributionResponse> getContribution(
       ContributionResponse contributionResponse
               = scorer.computeContribution(request);
       return ResponseEntity.ok(contributionResponse);
-    } catch (UnsupportedOperationException e) {
-      log.info("Unsupported operation due to: {}", e.getMessage());
-      return ResponseEntity.status(HttpStatus.NOT_IMPLEMENTED).build();
+    } catch (IllegalArgumentException e) {
+      String message = String.format("Unsupported operation due to: %s", e.getMessage());
+      throw new ScoringShapleyException(message, e);
     } catch (Exception e) {
-      log.info("Failed shapley contribution request due to: {}", e.getMessage());
-      log.debug(" - failure cause: ", e);
-      return ResponseEntity.badRequest().build();
+      String message = String.format(
+          "Failed shapley contribution request: %s, due to: %s",
+          request,
+          e.getMessage());
+      throw new ScoringShapleyException(message, e);
     }
   }
 

local-rest-scorer/src/main/java/ai/h2o/mojos/deploy/local/rest/exception/ModelsApiExceptionController.java

@@ -0,0 +1,33 @@
+package ai.h2o.mojos.deploy.local.rest.exception;
+
+import ai.h2o.mojos.deploy.common.exceptions.ScoringException;
+import ai.h2o.mojos.deploy.common.exceptions.ScoringShapleyException;
+import ai.h2o.mojos.deploy.local.rest.controller.ModelsApiController;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.ControllerAdvice;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler;
+
+@ControllerAdvice
+public class ModelsApiExceptionController extends ResponseEntityExceptionHandler {
+
+  private static final Logger log = LoggerFactory.getLogger(ModelsApiController.class);
+
+  @ExceptionHandler(value = ScoringException.class)
+  protected ResponseEntity<Object> handleScoringException(ScoringException scoringException) {
+    log.info(scoringException.getMessage());
+    log.debug(" - failure cause: ", scoringException);
+    return new ResponseEntity<>(scoringException.getMessage(), HttpStatus.BAD_REQUEST);
+  }
+
+  @ExceptionHandler(value = ScoringShapleyException.class)
+  protected ResponseEntity<Object> handleScoringShapleyException(
+      ScoringShapleyException scoringShapleyException) {
+    log.info(scoringShapleyException.getMessage());
+    log.debug(" - failure cause: ", scoringShapleyException);
+    return new ResponseEntity<>(scoringShapleyException.getMessage(), HttpStatus.BAD_REQUEST);
+  }
+}

settings.gradle

@@ -1,6 +1,7 @@
 rootProject.name = 'dai-deployment-templates'
 include 'aws-lambda-scorer:lambda-template'
 include 'aws-lambda-scorer:terraform-recipe'
+include 'common:exceptions'
 include 'common:jdbc'
 include 'common:rest-java-model'
 include 'common:rest-jdbc-spring-api'