Merge pull request #6293 from kenjis/refactor-Routes.php-loading

refactor: loading app/Config/routes.php

Author: kenjis

system/CodeIgniter.php

@@ -730,7 +730,7 @@ public function displayPerformanceMetrics(string $output): string
     protected function tryToRouteIt(?RouteCollectionInterface $routes = null)
     {
         if ($routes === null) {
-            require APPPATH . 'Config/Routes.php';
+            $routes = Services::routes()->loadRoutes();
         }
 
         // $routes is defined in Config/Routes.php

system/Commands/Utilities/FilterCheck.php

@@ -85,9 +85,7 @@ public function run(array $params)
         $route  = $params[1];
 
         // Load Routes
-        $routes = Services::routes();
-        require APPPATH . 'Config/Routes.php';
-        $routes->getRoutes('*'); // Triggers discovery
+        Services::routes()->loadRoutes();
 
         $filterCollector = new FilterCollector();
 

system/Commands/Utilities/Routes.php

@@ -75,10 +75,7 @@ class Routes extends BaseCommand
      */
     public function run(array $params)
     {
-        $routes = Services::routes(true);
-        require APPPATH . 'Config/Routes.php';
-
-        $collection = $routes;
+        $collection = Services::routes()->loadRoutes();
         $methods    = [
             'get',
             'head',

system/Router/RouteCollection.php

@@ -239,6 +239,62 @@ public function __construct(FileLocator $locator, Modules $moduleConfig)
         $this->httpHost = Services::request()->getServer('HTTP_HOST');
     }
 
+    /**
+     * Loads main routes file and discover routes.
+     *
+     * Loads only once unless reset.
+     *
+     * @return $this
+     */
+    public function loadRoutes(string $routesFile = APPPATH . 'Config/Routes.php')
+    {
+        if ($this->didDiscover) {
+            return $this;
+        }
+
+        $routes = $this;
+        require $routesFile;
+
+        $this->discoverRoutes();
+
+        return $this;
+    }
+
+    /**
+     * Will attempt to discover any additional routes, either through
+     * the local PSR4 namespaces, or through selected Composer packages.
+     */
+    protected function discoverRoutes()
+    {
+        if ($this->didDiscover) {
+            return;
+        }
+
+        // We need this var in local scope
+        // so route files can access it.
+        $routes = $this;
+
+        if ($this->moduleConfig->shouldDiscover('routes')) {
+            $files = $this->fileLocator->search('Config/Routes.php');
+
+            $excludes = [
+                APPPATH . 'Config' . DIRECTORY_SEPARATOR . 'Routes.php',
+                SYSTEMPATH . 'Config' . DIRECTORY_SEPARATOR . 'Routes.php',
+            ];
+
+            foreach ($files as $file) {
+                // Don't include our main file again...
+                if (in_array($file, $excludes, true)) {
+                    continue;
+                }
+
+                include $file;
+            }
+        }
+
+        $this->didDiscover = true;
+    }
+
     /**
      * Registers a new constraint with the system. Constraints are used
      * by the routes as placeholders for regular expressions to make defining
@@ -362,41 +418,6 @@ public function get404Override()
         return $this->override404;
     }
 
-    /**
-     * Will attempt to discover any additional routes, either through
-     * the local PSR4 namespaces, or through selected Composer packages.
-     */
-    protected function discoverRoutes()
-    {
-        if ($this->didDiscover) {
-            return;
-        }
-
-        // We need this var in local scope
-        // so route files can access it.
-        $routes = $this;
-
-        if ($this->moduleConfig->shouldDiscover('routes')) {
-            $files = $this->fileLocator->search('Config/Routes.php');
-
-            $excludes = [
-                APPPATH . 'Config' . DIRECTORY_SEPARATOR . 'Routes.php',
-                SYSTEMPATH . 'Config' . DIRECTORY_SEPARATOR . 'Routes.php',
-            ];
-
-            foreach ($files as $file) {
-                // Don't include our main file again...
-                if (in_array($file, $excludes, true)) {
-                    continue;
-                }
-
-                include $file;
-            }
-        }
-
-        $this->didDiscover = true;
-    }
-
     /**
      * Sets the default constraint to be used in the system. Typically
      * for use with the 'resource' method.
@@ -1393,6 +1414,7 @@ public function resetRoutes()
         }
 
         $this->prioritizeDetected = false;
+        $this->didDiscover        = false;
     }
 
     /**

system/Test/FeatureTestCase.php

@@ -176,12 +176,7 @@ public function call(string $method, string $path, ?array $params = null)
 
         // Initialize the RouteCollection
         if (! $routes = $this->routes) {
-            require APPPATH . 'Config/Routes.php';
-
-            /**
-             * @var RouteCollection $routes
-             */
-            $routes->getRoutes('*');
+            $routes = Services::routes()->loadRoutes();
         }
 
         $routes->setHTTPVerb($method);

system/Test/FeatureTestTrait.php

@@ -166,12 +166,7 @@ public function call(string $method, string $path, ?array $params = null)
 
         // Initialize the RouteCollection
         if (! $routes = $this->routes) {
-            require APPPATH . 'Config/Routes.php';
-
-            /**
-             * @var RouteCollection $routes
-             */
-            $routes->getRoutes('*');
+            $routes = Services::routes()->loadRoutes();
         }
 
         $routes->setHTTPVerb($method);

system/Test/FilterTestTrait.php

@@ -102,12 +102,7 @@ protected function setUpFilterTestTrait(): void
         $this->filters ??= new Filters($this->filtersConfig, $this->request, $this->response);
 
         if ($this->collection === null) {
-            // Load the RouteCollection from Config to gather App route info
-            // (creates $routes using the Service as a starting point)
-            require APPPATH . 'Config/Routes.php';
-
-            $routes->getRoutes('*'); // Triggers discovery
-            $this->collection = $routes;
+            $this->collection = Services::routes()->loadRoutes();
         }
 
         $this->doneFilterSetUp = true;

system/Test/bootstrap.php

@@ -10,7 +10,6 @@
  */
 
 use CodeIgniter\Config\DotEnv;
-use CodeIgniter\Router\RouteCollection;
 use Config\Autoload;
 use Config\Modules;
 use Config\Paths;
@@ -93,9 +92,4 @@
 // Always load the URL helper, it should be used in most of apps.
 helper('url');
 
-require_once APPPATH . 'Config/Routes.php';
-
-/**
- * @var RouteCollection $routes
- */
-$routes->getRoutes('*');
+Services::routes()->loadRoutes();

user_guide_src/source/changelogs/v4.3.0.rst

@@ -28,6 +28,7 @@ Others
 
 - The ``spark`` file has been changed due to a change in the processing of Spark commands.
 - ``InvalidArgumentException`` that is a kind of ``LogicException`` in ``BaseBuilder::_whereIn()`` is not suppressed by the configuration. Previously if ``CI_DEBUG`` was false, the exception was suppressed.
+- ``RouteCollection::resetRoutes()`` resets Auto-Discovery of Routes. Previously once discovered, RouteCollection never discover Routes files again even if ``RouteCollection::resetRoutes()`` is called.
 
 Enhancements
 ************