Add Context.forward fix jooby-project#1637

jknack · jknack · commit 97b8e4a0a4f7 · 2020-04-12T12:55:28.000-03:00
diff --git a/jooby/src/main/java/io/jooby/Context.java b/jooby/src/main/java/io/jooby/Context.java
@@ -95,6 +95,16 @@ public interface Context extends Registry {
    */
   @Nonnull Router getRouter();
 
+  /**
+   * Forward executing to another route. We use the given path to find a matching route.
+   *
+   * NOTE: the entire handler pipeline is executed (filter, decorator, etc.).
+   *
+   * @param path Path to forward the request.
+   * @return This context.
+   */
+  @Nonnull Context forward(@Nonnull String path);
+
   /**
    * Converts a value (single or hash) into the given type.
    *
@@ -219,6 +229,14 @@ public interface Context extends Registry {
    */
   @Nonnull String getRequestPath();
 
+  /**
+   * Set request path. This is usually done by Web Server or framework, but by user.
+   *
+   * @param path Request path.
+   * @return This context.
+   */
+  @Nonnull Context setRequestPath(@Nonnull String path);
+
   /**
    * Path variable. Value is decoded.
    *
diff --git a/jooby/src/main/java/io/jooby/DefaultContext.java b/jooby/src/main/java/io/jooby/DefaultContext.java
@@ -131,6 +131,12 @@ public interface DefaultContext extends Context {
     return session;
   }
 
+  @Override default @Nonnull Context forward(@Nonnull String path) {
+    setRequestPath(path);
+    getRouter().match(this).execute(this);
+    return this;
+  }
+
   @Override default @Nonnull Value cookie(@Nonnull String name) {
     String value = cookieMap().get(name);
     return value == null ? Value.missing(name) : Value.value(this, name, value);
diff --git a/jooby/src/main/java/io/jooby/ForwardingContext.java b/jooby/src/main/java/io/jooby/ForwardingContext.java
@@ -51,6 +51,11 @@ public ForwardingContext(@Nonnull Context context) {
     return this;
   }
 
+  @Nonnull @Override public Context forward(@Nonnull String path) {
+    ctx.forward(path);
+    return this;
+  }
+
   @Override public boolean matches(@Nonnull String pattern) {
     return ctx.matches(pattern);
   }
@@ -124,6 +129,11 @@ public ForwardingContext(@Nonnull Context context) {
     return ctx.getRequestPath();
   }
 
+  @Nonnull @Override public Context setRequestPath(@Nonnull String path) {
+    ctx.setRequestPath(path);
+    return this;
+  }
+
   @Nonnull @Override public Value path(@Nonnull String name) {
     return ctx.path(name);
   }
diff --git a/jooby/src/main/java/io/jooby/internal/RouterMatch.java b/jooby/src/main/java/io/jooby/internal/RouterMatch.java
@@ -27,11 +27,6 @@ public class RouterMatch implements Router.Match {
 
   private Route.Handler handler;
 
-  public RouterMatch(Route route) {
-    this.route = route;
-    this.matches = true;
-  }
-
   public RouterMatch() {
   }
 
@@ -41,10 +36,6 @@ public void key(List<String> keys) {
     }
   }
 
-  public void value(String value) {
-
-  }
-
   public void value(Chi.ZeroCopyString value) {
     if (vars == Collections.EMPTY_MAP) {
       vars = new LinkedHashMap();
diff --git a/modules/jooby-jetty/src/main/java/io/jooby/internal/jetty/JettyContext.java b/modules/jooby-jetty/src/main/java/io/jooby/internal/jetty/JettyContext.java
@@ -95,7 +95,7 @@ public class JettyContext implements DefaultContext {
   private boolean responseStarted;
   private Boolean resetHeadersOnError;
   private final String method;
-  private final String requestPath;
+  private String requestPath;
   private CompletionListeners listeners;
 
   public JettyContext(Request request, Router router, int bufferSize, long maxRequestSize) {
@@ -164,6 +164,11 @@ public JettyContext(Request request, Router router, int bufferSize, long maxRequ
     return requestPath;
   }
 
+  @Nonnull @Override public Context setRequestPath(@Nonnull String path) {
+    this.requestPath = path;
+    return this;
+  }
+
   @Nonnull @Override public Map<String, String> pathMap() {
     return pathMap;
   }
diff --git a/modules/jooby-netty/src/main/java/io/jooby/internal/netty/NettyContext.java b/modules/jooby-netty/src/main/java/io/jooby/internal/netty/NettyContext.java
@@ -112,7 +112,7 @@ public class NettyContext implements DefaultContext, ChannelFutureListener {
   private Route route;
   ChannelHandlerContext ctx;
   private HttpRequest req;
-  private final String path;
+  private String path;
   private HttpResponseStatus status = HttpResponseStatus.OK;
   private boolean responseStarted;
   private QueryString query;
@@ -176,6 +176,11 @@ public NettyContext(ChannelHandlerContext ctx, HttpRequest req, Router router, S
     return path;
   }
 
+  @Nonnull @Override public Context setRequestPath(String path) {
+    this.path = path;
+    return this;
+  }
+
   @Nonnull @Override public Map<String, String> pathMap() {
     return pathMap;
   }
diff --git a/modules/jooby-test/src/main/java/io/jooby/MockContext.java b/modules/jooby-test/src/main/java/io/jooby/MockContext.java
@@ -29,6 +29,7 @@
 import java.util.List;
 import java.util.Map;
 import java.util.concurrent.Executor;
+import java.util.function.Consumer;
 import java.util.stream.Collectors;
 import java.util.stream.IntStream;
 
@@ -81,6 +82,10 @@ public class MockContext implements DefaultContext {
 
   private CompletionListeners listeners = new CompletionListeners();
 
+  private Consumer<MockResponse> consumer;
+
+  private MockRouter mockRouter;
+
   @Nonnull @Override public String getMethod() {
     return method;
   }
@@ -122,6 +127,14 @@ public class MockContext implements DefaultContext {
     return cookies;
   }
 
+  @Nonnull @Override public Context forward(@Nonnull String path) {
+    setRequestPath(path);
+    if (mockRouter != null) {
+      mockRouter.call(getMethod(), path, this, consumer);
+    }
+    return this;
+  }
+
   /**
    * Set cookie map.
    *
@@ -680,4 +693,11 @@ public MockContext sendError(@Nonnull Throwable cause, @Nonnull StatusCode statu
     return method + " " + requestPath;
   }
 
+  void setConsumer(Consumer<MockResponse> consumer) {
+    this.consumer = consumer;
+  }
+
+  void setMockRouter(MockRouter mockRouter) {
+    this.mockRouter = mockRouter;
+  }
 }
diff --git a/modules/jooby-test/src/main/java/io/jooby/MockRouter.java b/modules/jooby-test/src/main/java/io/jooby/MockRouter.java
@@ -6,6 +6,7 @@
 package io.jooby;
 
 import javax.annotation.Nonnull;
+import java.util.Optional;
 import java.util.function.Consumer;
 import java.util.function.Supplier;
 
@@ -410,6 +411,8 @@ private MockValue call(Jooby router, String method, String path, Context ctx,
     findContext.setMethod(method.toUpperCase());
     findContext.setRequestPath(path);
     findContext.setRouter(router);
+    findContext.setConsumer(consumer);
+    findContext.setMockRouter(this);
 
     Router.Match match = router.match(findContext);
     Route route = match.route();
@@ -426,13 +429,14 @@ private MockValue call(Jooby router, String method, String path, Context ctx,
         value = handler.apply(ctx);
         if (ctx instanceof MockContext) {
           MockResponse response = ((MockContext) ctx).getResponse();
-          if (!(value instanceof Context)) {
+          if (value != null && !(value instanceof Context)) {
             response.setResult(value);
           }
           if (response.getContentLength() <= 0) {
             response.setContentLength(contentLength(value));
           }
           consumer.accept(response);
+          return new SingleMockValue(Optional.ofNullable(response.value()).orElse(value));
         }
         return new SingleMockValue(value);
       }
diff --git a/modules/jooby-test/src/test/java/issues/Issue1637.java b/modules/jooby-test/src/test/java/issues/Issue1637.java
@@ -0,0 +1,23 @@
+package issues;
+
+import io.jooby.Jooby;
+import io.jooby.MockRouter;
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+public class Issue1637 {
+
+  @Test
+  public void shouldForwardRoute() {
+    Jooby app = new Jooby();
+
+    app.get("/foo/{var}", ctx -> ctx.forward("/bar/" + ctx.path("var").value()));
+
+    app.get("/bar/{id}", ctx -> ctx.path("id").intValue());
+
+    MockRouter router = new MockRouter(app);
+
+    assertEquals(123, router.get("/foo/123").value());
+  }
+}
diff --git a/modules/jooby-utow/src/main/java/io/jooby/internal/utow/UtowContext.java b/modules/jooby-utow/src/main/java/io/jooby/internal/utow/UtowContext.java
@@ -84,7 +84,7 @@ public class UtowContext implements DefaultContext, IoCallback {
   private long responseLength = -1;
   private Boolean resetHeadersOnError;
   private final String method;
-  private final String requestPath;
+  private String requestPath;
   private UtowCompletionListener completionListener;
 
   public UtowContext(HttpServerExchange exchange, Router router) {
@@ -146,6 +146,11 @@ public UtowContext(HttpServerExchange exchange, Router router) {
     return requestPath;
   }
 
+  @Nonnull @Override public Context setRequestPath(@Nonnull String path) {
+    this.requestPath = path;
+    return this;
+  }
+
   @Nonnull @Override public Map<String, String> pathMap() {
     return pathMap;
   }
diff --git a/tests/src/test/java/io/jooby/FeaturedTest.java b/tests/src/test/java/io/jooby/FeaturedTest.java
@@ -16,7 +16,6 @@
 import okhttp3.MediaType;
 import okhttp3.MultipartBody;
 import okhttp3.RequestBody;
-import okhttp3.Response;
 import okhttp3.ResponseBody;
 import org.apache.commons.io.IOUtils;
 import org.junit.jupiter.api.DisplayName;
@@ -2919,6 +2918,20 @@ public void csrf(ServerTestRunner runner) {
     });
   }
 
+  @ServerTest
+  public void forward(ServerTestRunner runner) {
+    runner.define(app -> {
+      app.get("/api/v1/{object}", ctx -> ctx.forward("/api/v1.0/" + ctx.path("object").value()));
+
+      app.get("/api/v1.0/{name}", ctx -> ctx.path("name").value());
+    }).ready(client -> {
+      client.get("/api/v1/pets", rsp -> {
+        assertEquals(200, rsp.code());
+        assertEquals("pets", rsp.body().string());
+      });
+    });
+  }
+
   private byte[][] partition(byte[] bytes, int size) {
     List<byte[]> result = new ArrayList<>();
     int offset = 0;

Original file line number	Diff line number	Diff line change
`@@ -51,6 +51,11 @@ public ForwardingContext(@Nonnull Context context) {`
`51`	`51`	`return this;`
`52`	`52`	`}`
`53`	`53`
	`54`	`+ @Nonnull @Override public Context forward(@Nonnull String path) {`
	`55`	`+ ctx.forward(path);`
	`56`	`+ return this;`
	`57`	`+ }`
	`58`	`+`
`54`	`59`	`@Override public boolean matches(@Nonnull String pattern) {`
`55`	`60`	`return ctx.matches(pattern);`
`56`	`61`	`}`
`@@ -124,6 +129,11 @@ public ForwardingContext(@Nonnull Context context) {`
`124`	`129`	`return ctx.getRequestPath();`
`125`	`130`	`}`
`126`	`131`
	`132`	`+ @Nonnull @Override public Context setRequestPath(@Nonnull String path) {`
	`133`	`+ ctx.setRequestPath(path);`
	`134`	`+ return this;`
	`135`	`+ }`
	`136`	`+`
`127`	`137`	`@Nonnull @Override public Value path(@Nonnull String name) {`
`128`	`138`	`return ctx.path(name);`
`129`	`139`	`}`
Original file line number	Diff line number	Diff line change
`@@ -27,11 +27,6 @@ public class RouterMatch implements Router.Match {`
`27`	`27`
`28`	`28`	`private Route.Handler handler;`
`29`	`29`
`30`		`- public RouterMatch(Route route) {`
`31`		`- this.route = route;`
`32`		`- this.matches = true;`
`33`		`- }`
`34`		`-`
`35`	`30`	`public RouterMatch() {`
`36`	`31`	`}`
`37`	`32`
`@@ -41,10 +36,6 @@ public void key(List<String> keys) {`
`41`	`36`	`}`
`42`	`37`	`}`
`43`	`38`
`44`		`- public void value(String value) {`
`45`		`-`
`46`		`- }`
`47`		`-`
`48`	`39`	`public void value(Chi.ZeroCopyString value) {`
`49`	`40`	`if (vars == Collections.EMPTY_MAP) {`
`50`	`41`	`vars = new LinkedHashMap();`