Expose failure reason in ElideResponse

- Provide hook for building custom responses in JsonApiEndpoint

.gitignore

@@ -1,12 +1,15 @@
+.gradle/
+.idea/
+.sonar/
+bin/
 target/
 test-output/
-.settings
-.classpath
+
 .checkstyle
-.idea/
-.sonar/
+.classpath
+.settings
+
 *.iml
-bin
 dependency-reduced-pom.xml
 *.jar
 *.class

changelog.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## 4.2.7
+**Features**
+* Provide failure reason in ElideResponse
+* Expose response building in JsonApiEndpoint to allow for customization of response behavior
+
 ## 4.2.6
 **Fixes**
  * Fix NPE serializing Dates

elide-core/src/main/java/com/yahoo/elide/Elide.java

@@ -212,7 +212,7 @@ protected ElideResponse handleRequest(boolean isReadOnly, Object opaqueUser,
             }
             tx.flush(requestScope);
 
-            ElideResponse response = buildResponse(responder.get());
+            ElideResponse response = buildResponse(responder.get(), null);
 
             requestScope.runQueuedPreCommitTriggers();
             auditLogger.commit(requestScope);
@@ -236,7 +236,7 @@ protected ElideResponse handleRequest(boolean isReadOnly, Object opaqueUser,
 
         } catch (JsonPatchExtensionException e) {
             log.debug("JSON patch extension exception caught", e);
-            return buildResponse(e.getResponse());
+            return buildResponse(e.getResponse(), e);
 
         } catch (HttpStatusException e) {
             log.debug("Caught HTTP status exception", e);
@@ -276,19 +276,24 @@ protected ElideResponse buildErrorResponse(HttpStatusException error, boolean is
             ErrorObjects errors = ErrorObjects.builder().addError()
                     .withDetail(isVerbose ? error.getVerboseMessage() : error.toString()).build();
             JsonNode responseBody = mapper.getObjectMapper().convertValue(errors, JsonNode.class);
-            return buildResponse(Pair.of(error.getStatus(), responseBody));
+            return buildResponse(Pair.of(error.getStatus(), responseBody), error);
         }
-        return buildResponse(isVerbose ? error.getVerboseErrorResponse() : error.getErrorResponse());
+        return buildResponse(isVerbose ? error.getVerboseErrorResponse() : error.getErrorResponse(), error);
     }
 
+    @Deprecated
     protected ElideResponse buildResponse(Pair<Integer, JsonNode> response) {
+        return buildResponse(response, null);
+    }
+
+    protected ElideResponse buildResponse(Pair<Integer, JsonNode> response, Throwable failureReason) {
         try {
             JsonNode responseNode = response.getRight();
             Integer responseCode = response.getLeft();
             String body = responseNode == null ? null : mapper.writeJsonApiDocument(responseNode);
-            return new ElideResponse(responseCode, body);
+            return new ElideResponse(responseCode, body, failureReason);
         } catch (JsonProcessingException e) {
-            return new ElideResponse(HttpStatus.SC_INTERNAL_SERVER_ERROR, e.toString());
+            return new ElideResponse(HttpStatus.SC_INTERNAL_SERVER_ERROR, e.toString(), e);
         }
     }
 

elide-core/src/main/java/com/yahoo/elide/ElideResponse.java

@@ -13,15 +13,17 @@
 public class ElideResponse {
     @Getter private final int responseCode;
     @Getter private final String body;
+    @Getter private final Throwable failureReason;
 
     /**
      * Constructor.
      *
      * @param responseCode HTTP response code
      * @param body returned body string
      */
-    public ElideResponse(int responseCode, String body) {
+    public ElideResponse(int responseCode, String body, Throwable failureReason) {
         this.responseCode = responseCode;
         this.body = body;
+        this.failureReason = failureReason;
     }
 }

elide-core/src/main/java/com/yahoo/elide/resources/JsonApiEndpoint.java

@@ -42,7 +42,7 @@ public class JsonApiEndpoint {
     public JsonApiEndpoint(@Named("elide") Elide elide,
                            @Named("elideUserExtractionFunction") DefaultOpaqueUserFunction getUser) {
         this.elide = elide;
-        this.getUser = getUser == null ? v -> null : getUser;
+        this.getUser = getUser == null ? ctx -> null : getUser;
     }
 
     /**
@@ -121,7 +121,10 @@ public Response delete(
         return build(elide.delete(path, jsonApiDocument, getUser.apply(securityContext)));
     }
 
-    private static Response build(ElideResponse response) {
-        return Response.status(response.getResponseCode()).entity(response.getBody()).build();
+    protected Response build(ElideResponse response) {
+        return Response
+                .status(response.getResponseCode())
+                .entity(response.getBody())
+                .build();
     }
 }