Merge pull request #808 from DrorBuhnik/master

Add option to log url request including query string

Author: jknack

jooby/src/main/java/org/jooby/RequestLogger.java

@@ -197,6 +197,7 @@ public class RequestLogger implements Route.Handler {
   private static final char BL = '[';
   private static final char BR = ']';
   private static final char Q = '\"';
+  private static final char QUERY = '?';
 
   private static Function<Request, String> ANNON = req -> DASH;
 
@@ -211,6 +212,8 @@ public class RequestLogger implements Route.Handler {
 
   private boolean latency;
 
+  private boolean queryString;
+
   private boolean extended;
 
   /**
@@ -247,6 +250,9 @@ public void handle(final Request req, final Response rsp) throws Throwable {
       sb.append(Q).append(req.method());
       sb.append(SP);
       sb.append(req.path());
+      if (queryString) {
+        req.queryString().ifPresent(s -> sb.append(QUERY).append(s));
+      }
       sb.append(SP);
       sb.append(req.protocol());
       sb.append(Q).append(SP);
@@ -331,6 +337,16 @@ public RequestLogger latency() {
     return this;
   }
 
+  /**
+   * Log full path of the request including query string.
+   *
+   * @return This instance.
+   */
+  public RequestLogger queryString() {
+    this.queryString = true;
+    return this;
+  }
+
   /**
    * Append <code>Referer</code> and <code>User-Agent</code> entries to the NCSA line.
    *

jooby/src/test/java/org/jooby/RequestLoggerTest.java

@@ -70,6 +70,28 @@ public void latency() throws Exception {
         }, onComplete);
   }
 
+  @Test
+  public void queryString() throws Exception {
+    new MockUnit(Request.class, Response.class)
+        .expect(capture)
+        .expect(timestamp(7L))
+        .expect(ip("127.0.0.1"))
+        .expect(method("GET"))
+        .expect(path("/path"))
+        .expect(query("query=true"))
+        .expect(protocol("HTTP/1.1"))
+        .expect(status(Status.OK))
+        .expect(len(345L))
+        .run(unit -> {
+          new RequestLogger()
+              .dateFormatter(ZoneId.of("UTC"))
+              .queryString()
+              .log(line -> assertEquals(
+                  "127.0.0.1 - - [01/Jan/1970:00:00:00 +0000] \"GET /path?query=true HTTP/1.1\" 200 345", line))
+              .handle(unit.get(Request.class), unit.get(Response.class));
+        }, onComplete);
+  }
+
   @Test
   public void extended() throws Exception {
     new MockUnit(Request.class, Response.class)
@@ -147,6 +169,13 @@ private Block path(final String path) {
     };
   }
 
+  private Block query(final String query) {
+    return unit -> {
+      Request req = unit.get(Request.class);
+      expect(req.queryString()).andReturn(Optional.of(query));
+    };
+  }
+
   private Block status(final Status status) {
     return unit -> {
       Response rsp = unit.get(Response.class);