Convert routes to a node tree to improve route matching perfomance

Author: marcelthole

src/Map.php

@@ -420,4 +420,40 @@ public function attach($namePrefix, $pathPrefix, callable $callable)
         $callable($this);
         $this->protoRoute = $old;
     }
+
+    /**
+     * Convert all routes into a node tree array structure that contains all possible routes per route segment
+     * This will reduce the amount of possible routes to check
+     *
+     * @return array<string, Route|array<string, mixed>>
+     */
+    public function getAsTreeRouteNode()
+    {
+        $treeRoutes = [];
+        foreach ($this->routes as $route) {
+            if (! $route->isRoutable) {
+                continue;
+            }
+
+            // replace all parameters with {}
+            // This regexp will also work with "{controller:[a-zA-Z][a-zA-Z0-9_-]{1,}}"
+            $routePath = preg_replace('~{(?:[^{}]*|(?R))*}~', '{}', $route->path);
+            $node = &$treeRoutes;
+            foreach (explode('/', trim($routePath, '/')) as $segment) {
+                if (strpos($segment, '{') === 0 || strpos($segment, ':') === 0) {
+                    for ($i = 0; $i <= substr_count($segment, ','); $i++) {
+                        $node = &$node['{}'];
+                        $node[spl_object_hash($route)] = $route;
+                    }
+                    continue;
+                }
+                $node = &$node[$segment];
+            }
+
+            $node[spl_object_hash($route)] = $route;
+            unset($node);
+        }
+
+        return $treeRoutes;
+    }
 }

src/Matcher.php

@@ -113,8 +113,12 @@ public function match(ServerRequestInterface $request)
         $this->failedScore = 0;
         $path = $request->getUri()->getPath();
 
-        foreach ($this->map as $name => $proto) {
-            $route = $this->requestRoute($request, $proto, $name, $path);
+        $possibleRoutes = $this->getMatchedTree($path);
+        foreach ($possibleRoutes as $proto) {
+            if (is_array($proto)) {
+                continue;
+            }
+            $route = $this->requestRoute($request, $proto, $path);
             if ($route) {
                 return $route;
             }
@@ -131,20 +135,18 @@ public function match(ServerRequestInterface $request)
      *
      * @param Route $proto The proto-route to match against.
      *
-     * @param string $name The route name.
-     *
      * @param string $path The request path.
      *
      * @return mixed False on failure, or a Route on match.
      *
      */
-    protected function requestRoute($request, $proto, $name, $path)
+    protected function requestRoute($request, $proto, $path)
     {
         if (! $proto->isRoutable) {
-            return;
+            return false;
         }
         $route = clone $proto;
-        return $this->applyRules($request, $route, $name, $path);
+        return $this->applyRules($request, $route, $route->name, $path);
     }
 
     /**
@@ -261,4 +263,27 @@ public function getMatchedRoute()
     {
         return $this->matchedRoute;
     }
+
+    /**
+     * Split the URL into URL Segments and check for matching routes per segment
+     * This segment could return a list of possible routes
+     *
+     * @param string $path
+     * @return \RecursiveArrayIterator
+     */
+    private function getMatchedTree($path)
+    {
+        $node = $this->map->getAsTreeRouteNode();
+        foreach (explode('/', trim($path, '/')) as $segment) {
+            if (isset($node[$segment])) {
+                $node = $node[$segment];
+                continue;
+            }
+            if (isset($node['{}'])) {
+                $node = $node['{}'];
+            }
+        }
+
+        return new \RecursiveArrayIterator($node);
+    }
 }

tests/MatcherTest.php

@@ -258,7 +258,6 @@ public function testLogger()
         $matcher->match($request);
 
         $expect = [
-            'debug: /bar FAILED Aura\Router\Rule\Path ON foo',
             'debug: /bar MATCHED ON bar',
         ];
         $actual = $logger->lines;