Cache routes by action to avoid redundant O(N) iterations

Author: TavoNiievez

src/Codeception/Module/Symfony/CacheTrait.php

@@ -32,10 +32,8 @@ public function _getContainer(): ContainerInterface
     protected function getInternalDomains(): array
     {
         if (isset($this->state['internalDomains'])) {
-            /** @var list<non-empty-string> $domains */
-            $domains = $this->state['internalDomains'];
-
-            return $domains;
+            /** @var list<non-empty-string> */
+            return $this->state['internalDomains'];
         }
 
         $domains = [];
@@ -48,12 +46,14 @@ protected function getInternalDomains(): array
             }
         }
 
-        return $this->state['internalDomains'] = array_values(array_unique($domains));
+        /** @var list<non-empty-string> $domains */
+        $domains = array_values(array_unique($domains));
+        return $this->state['internalDomains'] = $domains;
     }
 
-    protected function clearInternalDomainsCache(): void
+    protected function clearRouterCache(): void
     {
-        unset($this->state['internalDomains']);
+        unset($this->state['internalDomains'], $this->state['cachedRoutes']);
     }
 
     /**
@@ -64,7 +64,6 @@ protected function clearInternalDomainsCache(): void
      */
     protected function grabCachedService(string $expectedClass, array $serviceIds): ?object
     {
-        /** @var ?string $serviceId */
         $serviceId = $this->state[$expectedClass] ??= (function () use ($serviceIds, $expectedClass): ?string {
             foreach ($serviceIds as $id) {
                 if ($this->getService($id) instanceof $expectedClass) {
@@ -75,7 +74,7 @@ protected function grabCachedService(string $expectedClass, array $serviceIds):
             return null;
         })();
 
-        if ($serviceId === null) {
+        if (!is_string($serviceId)) {
             return null;
         }
 

src/Codeception/Module/Symfony/RouterAssertionsTrait.php

@@ -55,7 +55,7 @@ public function amOnRoute(string $routeName, array $params = []): void
     public function invalidateCachedRouter(): void
     {
         $this->unpersistService('router');
-        $this->clearInternalDomainsCache();
+        $this->clearRouterCache();
     }
 
     /**
@@ -118,15 +118,34 @@ private function getCurrentRouteMatch(string $routeName): array
 
     private function findRouteByActionOrFail(string $action): string
     {
-        foreach ($this->grabRouterService()->getRouteCollection()->all() as $name => $route) {
-            $ctrl = $route->getDefault('_controller');
-            if (is_string($ctrl) && str_ends_with($ctrl, $action)) {
+        foreach ($this->getCachedRoutes() as $ctrl => $name) {
+            if (str_ends_with($ctrl, $action)) {
                 return $name;
             }
         }
+
         Assert::fail(sprintf("Action '%s' does not exist.", $action));
     }
 
+    /** @return array<string, string> */
+    private function getCachedRoutes(): array
+    {
+        if (isset($this->state['cachedRoutes'])) {
+            /** @var array<string, string> */
+            return $this->state['cachedRoutes'];
+        }
+
+        $routes = [];
+        foreach ($this->grabRouterService()->getRouteCollection()->all() as $name => $route) {
+            $ctrl = $route->getDefault('_controller');
+            if (is_string($ctrl) && !isset($routes[$ctrl])) {
+                $routes[$ctrl] = (string) $name;
+            }
+        }
+
+        return $this->state['cachedRoutes'] = $routes;
+    }
+
     private function assertRouteExists(string $routeName): void
     {
         $this->assertNotNull(