Case insensitive route fix jooby-project#880

jknack · jknack · commit 6add6acb6593 · 2017-10-19T20:25:38.000-03:00
diff --git a/jooby/src/main/java/org/jooby/Jooby.java b/jooby/src/main/java/org/jooby/Jooby.java
diff --git a/jooby/src/main/java/org/jooby/Route.java b/jooby/src/main/java/org/jooby/Route.java
@@ -1378,6 +1378,19 @@ public Definition(final String verb, final String pattern,
       this(verb, pattern, (Route.Filter) handler);
     }
 
+    /**
+     * Creates a new route definition.
+     *
+     * @param verb A HTTP verb or <code>*</code>.
+     * @param pattern A path pattern.
+     * @param handler A route handler.
+     * @param caseSensitiveRouting Configure case for routing algorithm.
+     */
+    public Definition(final String verb, final String pattern,
+        final Route.Handler handler, boolean caseSensitiveRouting) {
+      this(verb, pattern, (Route.Filter) handler, caseSensitiveRouting);
+    }
+
     /**
      * Creates a new route definition.
      *
@@ -1409,13 +1422,25 @@ public Definition(final String verb, final String pattern,
      * @param pattern A path pattern.
      * @param filter A callback to execute.
      */
+    public Definition(final String method, final String pattern, final Filter filter) {
+      this(method, pattern, filter, true);
+    }
+
+    /**
+     * Creates a new route definition.
+     *
+     * @param method A HTTP verb or <code>*</code>.
+     * @param pattern A path pattern.
+     * @param filter A callback to execute.
+     * @param caseSensitiveRouting Configure case for routing algorithm.
+     */
     public Definition(final String method, final String pattern,
-        final Filter filter) {
+        final Filter filter, boolean caseSensitiveRouting) {
       requireNonNull(pattern, "A route path is required.");
       requireNonNull(filter, "A filter is required.");
 
       this.method = method.toUpperCase();
-      this.cpattern = new RoutePattern(method, pattern);
+      this.cpattern = new RoutePattern(method, pattern, !caseSensitiveRouting);
       // normalized pattern
       this.pattern = cpattern.pattern();
       this.filter = filter;
diff --git a/jooby/src/main/java/org/jooby/internal/RoutePattern.java b/jooby/src/main/java/org/jooby/internal/RoutePattern.java
diff --git a/jooby/src/main/java/org/jooby/internal/SimpleRouteMatcher.java b/jooby/src/main/java/org/jooby/internal/SimpleRouteMatcher.java
@@ -207,11 +207,11 @@
 
 class SimpleRouteMatcher implements RouteMatcher {
 
-  private final String fullpath;
+  protected final String fullpath;
 
   private final String path;
 
-  private String pattern;
+  protected String pattern;
 
   public SimpleRouteMatcher(final String pattern, final String path, final String fullpath) {
     this.pattern = requireNonNull(pattern, "A pattern is required.");
diff --git a/jooby/src/main/java/org/jooby/internal/SimpleRouteMatcherNoCase.java b/jooby/src/main/java/org/jooby/internal/SimpleRouteMatcherNoCase.java
@@ -0,0 +1,217 @@
+/**
+ *                                  Apache License
+ *                            Version 2.0, January 2004
+ *                         http://www.apache.org/licenses/
+ *
+ *    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+ *
+ *    1. Definitions.
+ *
+ *       "License" shall mean the terms and conditions for use, reproduction,
+ *       and distribution as defined by Sections 1 through 9 of this document.
+ *
+ *       "Licensor" shall mean the copyright owner or entity authorized by
+ *       the copyright owner that is granting the License.
+ *
+ *       "Legal Entity" shall mean the union of the acting entity and all
+ *       other entities that control, are controlled by, or are under common
+ *       control with that entity. For the purposes of this definition,
+ *       "control" means (i) the power, direct or indirect, to cause the
+ *       direction or management of such entity, whether by contract or
+ *       otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ *       outstanding shares, or (iii) beneficial ownership of such entity.
+ *
+ *       "You" (or "Your") shall mean an individual or Legal Entity
+ *       exercising permissions granted by this License.
+ *
+ *       "Source" form shall mean the preferred form for making modifications,
+ *       including but not limited to software source code, documentation
+ *       source, and configuration files.
+ *
+ *       "Object" form shall mean any form resulting from mechanical
+ *       transformation or translation of a Source form, including but
+ *       not limited to compiled object code, generated documentation,
+ *       and conversions to other media types.
+ *
+ *       "Work" shall mean the work of authorship, whether in Source or
+ *       Object form, made available under the License, as indicated by a
+ *       copyright notice that is included in or attached to the work
+ *       (an example is provided in the Appendix below).
+ *
+ *       "Derivative Works" shall mean any work, whether in Source or Object
+ *       form, that is based on (or derived from) the Work and for which the
+ *       editorial revisions, annotations, elaborations, or other modifications
+ *       represent, as a whole, an original work of authorship. For the purposes
+ *       of this License, Derivative Works shall not include works that remain
+ *       separable from, or merely link (or bind by name) to the interfaces of,
+ *       the Work and Derivative Works thereof.
+ *
+ *       "Contribution" shall mean any work of authorship, including
+ *       the original version of the Work and any modifications or additions
+ *       to that Work or Derivative Works thereof, that is intentionally
+ *       submitted to Licensor for inclusion in the Work by the copyright owner
+ *       or by an individual or Legal Entity authorized to submit on behalf of
+ *       the copyright owner. For the purposes of this definition, "submitted"
+ *       means any form of electronic, verbal, or written communication sent
+ *       to the Licensor or its representatives, including but not limited to
+ *       communication on electronic mailing lists, source code control systems,
+ *       and issue tracking systems that are managed by, or on behalf of, the
+ *       Licensor for the purpose of discussing and improving the Work, but
+ *       excluding communication that is conspicuously marked or otherwise
+ *       designated in writing by the copyright owner as "Not a Contribution."
+ *
+ *       "Contributor" shall mean Licensor and any individual or Legal Entity
+ *       on behalf of whom a Contribution has been received by Licensor and
+ *       subsequently incorporated within the Work.
+ *
+ *    2. Grant of Copyright License. Subject to the terms and conditions of
+ *       this License, each Contributor hereby grants to You a perpetual,
+ *       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ *       copyright license to reproduce, prepare Derivative Works of,
+ *       publicly display, publicly perform, sublicense, and distribute the
+ *       Work and such Derivative Works in Source or Object form.
+ *
+ *    3. Grant of Patent License. Subject to the terms and conditions of
+ *       this License, each Contributor hereby grants to You a perpetual,
+ *       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ *       (except as stated in this section) patent license to make, have made,
+ *       use, offer to sell, sell, import, and otherwise transfer the Work,
+ *       where such license applies only to those patent claims licensable
+ *       by such Contributor that are necessarily infringed by their
+ *       Contribution(s) alone or by combination of their Contribution(s)
+ *       with the Work to which such Contribution(s) was submitted. If You
+ *       institute patent litigation against any entity (including a
+ *       cross-claim or counterclaim in a lawsuit) alleging that the Work
+ *       or a Contribution incorporated within the Work constitutes direct
+ *       or contributory patent infringement, then any patent licenses
+ *       granted to You under this License for that Work shall terminate
+ *       as of the date such litigation is filed.
+ *
+ *    4. Redistribution. You may reproduce and distribute copies of the
+ *       Work or Derivative Works thereof in any medium, with or without
+ *       modifications, and in Source or Object form, provided that You
+ *       meet the following conditions:
+ *
+ *       (a) You must give any other recipients of the Work or
+ *           Derivative Works a copy of this License; and
+ *
+ *       (b) You must cause any modified files to carry prominent notices
+ *           stating that You changed the files; and
+ *
+ *       (c) You must retain, in the Source form of any Derivative Works
+ *           that You distribute, all copyright, patent, trademark, and
+ *           attribution notices from the Source form of the Work,
+ *           excluding those notices that do not pertain to any part of
+ *           the Derivative Works; and
+ *
+ *       (d) If the Work includes a "NOTICE" text file as part of its
+ *           distribution, then any Derivative Works that You distribute must
+ *           include a readable copy of the attribution notices contained
+ *           within such NOTICE file, excluding those notices that do not
+ *           pertain to any part of the Derivative Works, in at least one
+ *           of the following places: within a NOTICE text file distributed
+ *           as part of the Derivative Works; within the Source form or
+ *           documentation, if provided along with the Derivative Works; or,
+ *           within a display generated by the Derivative Works, if and
+ *           wherever such third-party notices normally appear. The contents
+ *           of the NOTICE file are for informational purposes only and
+ *           do not modify the License. You may add Your own attribution
+ *           notices within Derivative Works that You distribute, alongside
+ *           or as an addendum to the NOTICE text from the Work, provided
+ *           that such additional attribution notices cannot be construed
+ *           as modifying the License.
+ *
+ *       You may add Your own copyright statement to Your modifications and
+ *       may provide additional or different license terms and conditions
+ *       for use, reproduction, or distribution of Your modifications, or
+ *       for any such Derivative Works as a whole, provided Your use,
+ *       reproduction, and distribution of the Work otherwise complies with
+ *       the conditions stated in this License.
+ *
+ *    5. Submission of Contributions. Unless You explicitly state otherwise,
+ *       any Contribution intentionally submitted for inclusion in the Work
+ *       by You to the Licensor shall be under the terms and conditions of
+ *       this License, without any additional terms or conditions.
+ *       Notwithstanding the above, nothing herein shall supersede or modify
+ *       the terms of any separate license agreement you may have executed
+ *       with Licensor regarding such Contributions.
+ *
+ *    6. Trademarks. This License does not grant permission to use the trade
+ *       names, trademarks, service marks, or product names of the Licensor,
+ *       except as required for reasonable and customary use in describing the
+ *       origin of the Work and reproducing the content of the NOTICE file.
+ *
+ *    7. Disclaimer of Warranty. Unless required by applicable law or
+ *       agreed to in writing, Licensor provides the Work (and each
+ *       Contributor provides its Contributions) on an "AS IS" BASIS,
+ *       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ *       implied, including, without limitation, any warranties or conditions
+ *       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ *       PARTICULAR PURPOSE. You are solely responsible for determining the
+ *       appropriateness of using or redistributing the Work and assume any
+ *       risks associated with Your exercise of permissions under this License.
+ *
+ *    8. Limitation of Liability. In no event and under no legal theory,
+ *       whether in tort (including negligence), contract, or otherwise,
+ *       unless required by applicable law (such as deliberate and grossly
+ *       negligent acts) or agreed to in writing, shall any Contributor be
+ *       liable to You for damages, including any direct, indirect, special,
+ *       incidental, or consequential damages of any character arising as a
+ *       result of this License or out of the use or inability to use the
+ *       Work (including but not limited to damages for loss of goodwill,
+ *       work stoppage, computer failure or malfunction, or any and all
+ *       other commercial damages or losses), even if such Contributor
+ *       has been advised of the possibility of such damages.
+ *
+ *    9. Accepting Warranty or Additional Liability. While redistributing
+ *       the Work or Derivative Works thereof, You may choose to offer,
+ *       and charge a fee for, acceptance of support, warranty, indemnity,
+ *       or other liability obligations and/or rights consistent with this
+ *       License. However, in accepting such obligations, You may act only
+ *       on Your own behalf and on Your sole responsibility, not on behalf
+ *       of any other Contributor, and only if You agree to indemnify,
+ *       defend, and hold each Contributor harmless for any liability
+ *       incurred by, or claims asserted against, such Contributor by reason
+ *       of your accepting any such warranty or additional liability.
+ *
+ *    END OF TERMS AND CONDITIONS
+ *
+ *    APPENDIX: How to apply the Apache License to your work.
+ *
+ *       To apply the Apache License to your work, attach the following
+ *       boilerplate notice, with the fields enclosed by brackets "{}"
+ *       replaced with your own identifying information. (Don't include
+ *       the brackets!)  The text should be enclosed in the appropriate
+ *       comment syntax for the file format. We also recommend that a
+ *       file or class name and description of purpose be included on the
+ *       same "printed page" as the copyright notice for easier
+ *       identification within third-party archives.
+ *
+ *    Copyright 2014 Edgar Espina
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+package org.jooby.internal;
+
+class SimpleRouteMatcherNoCase extends SimpleRouteMatcher {
+
+  public SimpleRouteMatcherNoCase(String pattern, String path, String fullpath) {
+    super(pattern, path, fullpath);
+  }
+
+  @Override
+  public boolean matches() {
+    return fullpath.equalsIgnoreCase(pattern);
+  }
+
+}
diff --git a/jooby/src/main/java/org/jooby/internal/mvc/MvcRoutes.java b/jooby/src/main/java/org/jooby/internal/mvc/MvcRoutes.java
@@ -257,7 +257,7 @@ public class MvcRoutes {
       .build();
 
   public static List<Route.Definition> routes(final Env env, final RouteMetadata classInfo,
-      final String rpath, final Class<?> routeClass) {
+      final String rpath, boolean caseSensitiveRouting, final Class<?> routeClass) {
 
     // check and fail fast
     methods(routeClass, methods -> {
@@ -311,7 +311,7 @@ public static List<Route.Definition> routes(final Env env, final RouteMetadata c
               String[] excludes = excludes(method, rootExcludes);
 
               Definition definition = new Route.Definition(
-                  verb.getSimpleName(), rpath + "/" + path, new MvcHandler(method, routeClass, paramProvider))
+                  verb.getSimpleName(), rpath + "/" + path, new MvcHandler(method, routeClass, paramProvider), caseSensitiveRouting)
                   .produces(produces)
                   .consumes(consumes)
                   .excludes(excludes)
diff --git a/jooby/src/test/java/org/jooby/internal/RoutePatternTest.java b/jooby/src/test/java/org/jooby/internal/RoutePatternTest.java
@@ -15,8 +15,12 @@ class RoutePathAssert {
 
     RoutePattern path;
 
+    public RoutePathAssert(final String method, final String pattern, boolean ignoreCase) {
+      path = new RoutePattern(method, pattern, ignoreCase);
+    }
+
     public RoutePathAssert(final String method, final String pattern) {
-      path = new RoutePattern(method, pattern);
+      this(method, pattern, false);
     }
 
     public RoutePathAssert matches(final String path) {
@@ -436,7 +440,21 @@ public void cornerCase() {
 
     new RoutePathAssert("GET", "/m/**")
         .butNot("GET/merge/login");
+  }
+
+  @Test
+  public void ignoreCase() {
+    new RoutePathAssert("GET", "/path/:id", true)
+        .matches("GET/path/aB", vars -> {
+          assertEquals("aB", vars.get(0));
+        })
+        .matches("GET/Path/ab", vars -> {
+          assertEquals("ab", vars.get(0));
+        });
 
+    new RoutePathAssert("GET", "/path1", true)
+        .matches("GET/path1")
+        .matches("GET/Path1");
   }
 
 }
diff --git a/jooby/src/test/java/org/jooby/internal/mvc/MvcRoutesTest.java b/jooby/src/test/java/org/jooby/internal/mvc/MvcRoutesTest.java
@@ -37,7 +37,8 @@ public void nopath() throws Exception {
         })
         .run(unit -> {
           Env env = unit.get(Env.class);
-          List<Definition> routes = MvcRoutes.routes(env, new RouteMetadata(env), "", NoPath.class);
+          List<Definition> routes = MvcRoutes.routes(env, new RouteMetadata(env), "",
+              true, NoPath.class);
           System.out.println(routes);
         });
   }
diff --git a/jooby/src/test/java/org/jooby/issues/Issue372.java b/jooby/src/test/java/org/jooby/issues/Issue372.java
@@ -34,7 +34,7 @@ public void shouldFailFastOnPrivateMvcRoutes() throws Exception {
         })
         .run(unit -> {
           Env env = unit.get(Env.class);
-          MvcRoutes.routes(env, new RouteMetadata(env), "", PingRoute.class);
+          MvcRoutes.routes(env, new RouteMetadata(env), "", true, PingRoute.class);
         });
   }
 
@@ -47,7 +47,7 @@ public void shouldFailFastOnPrivateMvcRoutesExt() throws Exception {
         })
         .run(unit -> {
           Env env = unit.get(Env.class);
-          MvcRoutes.routes(env, new RouteMetadata(env), "", Ext.class);
+          MvcRoutes.routes(env, new RouteMetadata(env), "", true, Ext.class);
         });
   }
 
diff --git a/modules/coverage-report/src/test/java/org/jooby/issues/Issue880.java b/modules/coverage-report/src/test/java/org/jooby/issues/Issue880.java
@@ -0,0 +1,35 @@
+package org.jooby.issues;
+
+import org.jooby.test.ServerFeature;
+import org.junit.Test;
+
+public class Issue880 extends ServerFeature {
+
+  {
+    caseSensitiveRouting(false);
+
+    get("/880/path", req -> req.path());
+    get("/880/path/:id", req -> req.path());
+  }
+
+  @Test
+  public void shouldIgnoreCase() throws Exception {
+    request().get("/880/path")
+        .expect("/880/path");
+    request().get("/880/Path")
+        .expect("/880/Path");
+
+    request().get("/880/PatH")
+        .expect("/880/PatH");
+
+    request().get("/880/path/AB")
+        .expect("/880/path/AB");
+
+    request().get("/880/path/ab")
+        .expect("/880/path/ab");
+
+    request().get("/880/paTh/AB")
+        .expect("/880/paTh/AB");
+  }
+
+}
diff --git a/modules/jooby-apitool/src/main/java/org/jooby/internal/apitool/BytecodeRouteParser.java b/modules/jooby-apitool/src/main/java/org/jooby/internal/apitool/BytecodeRouteParser.java
