Support Problem Details for HTTP APIs RFC7807 (#3552)

* HttpProblem abstraction

* ProblemDetailsErrorHandler

* new media types for problem details

* tests

* resolve comments

* resolve conflicts

resolve conflicts

Author: kliushnichenko

jooby/pom.xml

@@ -69,6 +69,18 @@
       <scope>test</scope>
     </dependency>
 
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter-params</artifactId>
+      <scope>test</scope>
+    </dependency>
+
+    <dependency>
+      <groupId>org.assertj</groupId>
+      <artifactId>assertj-core</artifactId>
+      <scope>test</scope>
+    </dependency>
+
     <dependency>
       <groupId>org.jacoco</groupId>
       <artifactId>org.jacoco.agent</artifactId>

jooby/src/main/java/io/jooby/DefaultErrorHandler.java

@@ -120,7 +120,7 @@ public void apply(@NonNull Context ctx, @NonNull Throwable cause, @NonNull Statu
     }
   }
 
-  private boolean isMuted(Throwable cause, StatusCode statusCode) {
+  protected boolean isMuted(Throwable cause, StatusCode statusCode) {
     return muteCodes.contains(statusCode)
         // same class filter
         || muteTypes.stream().anyMatch(type -> type == cause.getClass())

jooby/src/main/java/io/jooby/MediaType.java

@@ -36,9 +36,15 @@ public final class MediaType implements Comparable<MediaType> {
   /** APPLICATION_JSON. */
   public static final String JSON = "application/json";
 
+  /** APPLICATION_PROBLEM_JSON. */
+  public static final String PROBLEM_JSON = "application/problem+json";
+
   /** APPLICATION_XML. */
   public static final String XML = "application/xml";
 
+  /** APPLICATION_PROBLEM_XML. */
+  public static final String PROBLEM_XML = "application/problem+xml";
+
   /** TEXT_PLAIN. */
   public static final String TEXT = "text/plain";
 
@@ -81,7 +87,7 @@ public final class MediaType implements Comparable<MediaType> {
   /** TEXT_HTML. */
   public static final MediaType html = new MediaType(HTML, UTF_8);
 
-  /** APPLICATION_JSON. */
+  /** APPLICATION_JAVASCRIPT. */
   public static final MediaType js = new MediaType(JS, UTF_8);
 
   /** TEXT_CSS. */

jooby/src/main/java/io/jooby/exception/InvalidCsrfToken.java

@@ -6,6 +6,7 @@
 package io.jooby.exception;
 
 import edu.umd.cs.findbugs.annotations.Nullable;
+import io.jooby.problem.HttpProblem;
 
 /**
  * Generate by CSRF handler.
@@ -23,4 +24,11 @@ public class InvalidCsrfToken extends ForbiddenException {
   public InvalidCsrfToken(@Nullable String token) {
     super(token);
   }
+
+  @Override
+  public HttpProblem toHttpProblem() {
+    return HttpProblem.valueOf(statusCode,
+        "Invalid CSRF token",
+        "CSRF token '" + getMessage() + "' is invalid");
+  }
 }

jooby/src/main/java/io/jooby/exception/MethodNotAllowedException.java

@@ -9,6 +9,7 @@
 
 import edu.umd.cs.findbugs.annotations.NonNull;
 import io.jooby.StatusCode;
+import io.jooby.problem.HttpProblem;
 
 /**
  * Whether a HTTP method isn't supported. The {@link #getAllow()} contains the supported HTTP
@@ -48,4 +49,12 @@ public String getMethod() {
   public List<String> getAllow() {
     return allow;
   }
+
+  @Override
+  public HttpProblem toHttpProblem() {
+    return HttpProblem.valueOf(statusCode,
+        statusCode.reason(),
+        "HTTP method '" + getMethod() + "' is not allowed. Allowed methods are: " + allow
+    );
+  }
 }

jooby/src/main/java/io/jooby/exception/NotAcceptableException.java

@@ -7,6 +7,7 @@
 
 import edu.umd.cs.findbugs.annotations.Nullable;
 import io.jooby.StatusCode;
+import io.jooby.problem.HttpProblem;
 
 /**
  * Whether the accept header isn't acceptable.
@@ -32,4 +33,13 @@ public NotAcceptableException(@Nullable String contentType) {
   public @Nullable String getContentType() {
     return getMessage();
   }
+
+  @Override
+  public HttpProblem toHttpProblem() {
+    return HttpProblem.valueOf(statusCode,
+        statusCode.reason(),
+        "Server cannot produce a response matching the list of " +
+        "acceptable values defined in the request's 'Accept' header"
+    );
+  }
 }

jooby/src/main/java/io/jooby/exception/NotFoundException.java

@@ -7,6 +7,7 @@
 
 import edu.umd.cs.findbugs.annotations.NonNull;
 import io.jooby.StatusCode;
+import io.jooby.problem.HttpProblem;
 
 /**
  * When a request doesn't match any of the available routes.
@@ -33,4 +34,11 @@ public NotFoundException(@NonNull String path) {
   public @NonNull String getRequestPath() {
     return getMessage();
   }
+
+  @Override
+  public HttpProblem toHttpProblem() {
+    return HttpProblem.valueOf(statusCode,
+        statusCode.reason(),
+        "Route '" + getRequestPath() + "' not found. Please verify request path");
+  }
 }

jooby/src/main/java/io/jooby/exception/StatusCodeException.java

@@ -8,16 +8,18 @@
 import edu.umd.cs.findbugs.annotations.NonNull;
 import edu.umd.cs.findbugs.annotations.Nullable;
 import io.jooby.StatusCode;
+import io.jooby.problem.HttpProblem;
+import io.jooby.problem.HttpProblemMappable;
 
 /**
  * Runtime exception with status code.
  *
  * @author edgar
  * @since 2.0.0
  */
-public class StatusCodeException extends RuntimeException {
+public class StatusCodeException extends RuntimeException implements HttpProblemMappable {
 
-  private final StatusCode statusCode;
+  protected final StatusCode statusCode;
 
   /**
    * Creates an error with the given status code.
@@ -59,4 +61,9 @@ public StatusCodeException(
   public @NonNull StatusCode getStatusCode() {
     return statusCode;
   }
+
+  @Override
+  public HttpProblem toHttpProblem() {
+    return HttpProblem.valueOf(statusCode, getMessage());
+  }
 }

jooby/src/main/java/io/jooby/exception/TypeMismatchException.java

@@ -8,6 +8,7 @@
 import java.lang.reflect.Type;
 
 import edu.umd.cs.findbugs.annotations.NonNull;
+import io.jooby.problem.HttpProblem;
 
 /**
  * Type mismatch exception. Used when a value can't be converted to the required type.
@@ -48,4 +49,10 @@ public TypeMismatchException(@NonNull String name, @NonNull Type type) {
   public @NonNull String getName() {
     return name;
   }
+
+
+  @Override
+  public HttpProblem toHttpProblem() {
+    return HttpProblem.valueOf(statusCode, "Type Mismatch", getMessage());
+  }
 }

jooby/src/main/java/io/jooby/exception/UnsupportedMediaType.java

@@ -7,6 +7,7 @@
 
 import edu.umd.cs.findbugs.annotations.Nullable;
 import io.jooby.StatusCode;
+import io.jooby.problem.HttpProblem;
 
 /**
  * Whether there is no decoder for the requested <code>Content-Type</code>.
@@ -32,4 +33,11 @@ public UnsupportedMediaType(@Nullable String type) {
   public @Nullable String getContentType() {
     return getMessage();
   }
+
+  @Override
+  public HttpProblem toHttpProblem() {
+    return HttpProblem.valueOf(statusCode,
+        statusCode.reason(),
+        "Media type '" + getContentType() + "' is not supported");
+  }
 }