Merge pull request #18514 from MauricioFauth/routes

MauricioFauth · web-flow · commit 98e0676a70c5 · 2023-06-27T10:58:20.000-03:00
Move the routes from routes.php to the Routes class
diff --git a/libraries/classes/Application.php b/libraries/classes/Application.php
@@ -18,6 +18,7 @@
 use PhpMyAdmin\Identifiers\TableName;
 use PhpMyAdmin\Plugins\AuthenticationPlugin;
 use PhpMyAdmin\Plugins\AuthenticationPluginFactory;
+use PhpMyAdmin\Routing\Routing;
 use PhpMyAdmin\SqlParser\Lexer;
 use PhpMyAdmin\Theme\ThemeManager;
 use PhpMyAdmin\Tracking\Tracker;
diff --git a/libraries/classes/Command/CacheWarmupCommand.php b/libraries/classes/Command/CacheWarmupCommand.php
@@ -6,7 +6,7 @@
 
 use PhpMyAdmin\Config;
 use PhpMyAdmin\DatabaseInterface;
-use PhpMyAdmin\Routing;
+use PhpMyAdmin\Routing\Routing;
 use PhpMyAdmin\Template;
 use PhpMyAdmin\Tests\Stubs\DbiDummy;
 use RecursiveDirectoryIterator;
diff --git a/libraries/classes/Config.php b/libraries/classes/Config.php
@@ -8,6 +8,7 @@
 use PhpMyAdmin\Config\Settings\Server;
 use PhpMyAdmin\Dbal\Connection;
 use PhpMyAdmin\Exceptions\ConfigException;
+use PhpMyAdmin\Routing\Routing;
 use PhpMyAdmin\Theme\ThemeManager;
 use Throwable;
 
diff --git a/libraries/classes/Routing/Routes.php b/libraries/classes/Routing/Routes.php
diff --git a/libraries/classes/Routing/Routing.php b/libraries/classes/Routing/Routing.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace PhpMyAdmin;
+namespace PhpMyAdmin\Routing;
 
 use FastRoute\DataGenerator\GroupCountBased as DataGeneratorGroupCountBased;
 use FastRoute\Dispatcher;
@@ -13,7 +13,12 @@
 use PhpMyAdmin\Controllers\Setup\MainController;
 use PhpMyAdmin\Controllers\Setup\ShowConfigController;
 use PhpMyAdmin\Controllers\Setup\ValidateController;
+use PhpMyAdmin\Core;
 use PhpMyAdmin\Http\ServerRequest;
+use PhpMyAdmin\Message;
+use PhpMyAdmin\ResponseRenderer;
+use PhpMyAdmin\Sanitize;
+use PhpMyAdmin\Template;
 use Psr\Container\ContainerInterface;
 
 use function __;
@@ -38,7 +43,6 @@
 
 use const CACHE_DIR;
 use const E_USER_WARNING;
-use const ROOT_PATH;
 
 /**
  * Class used to warm up the routing cache and manage routing.
@@ -47,13 +51,6 @@ class Routing
 {
     public const ROUTES_CACHE_FILE = CACHE_DIR . 'routes.cache.php';
 
-    public static function getDispatcher(): Dispatcher
-    {
-        $routes = require ROOT_PATH . 'libraries/routes.php';
-
-        return self::routesCachedDispatcher($routes);
-    }
-
     public static function skipCache(): bool
     {
         return ($GLOBALS['cfg']['environment'] ?? '') === 'development';
@@ -75,7 +72,7 @@ public static function canWriteCache(): bool
         return $canWriteFile;
     }
 
-    private static function routesCachedDispatcher(callable $routeDefinitionCallback): Dispatcher
+    public static function getDispatcher(): Dispatcher
     {
         $skipCache = self::skipCache();
 
@@ -89,11 +86,8 @@ private static function routesCachedDispatcher(callable $routeDefinitionCallback
             }
         }
 
-        $routeCollector = new RouteCollector(
-            new RouteParserStd(),
-            new DataGeneratorGroupCountBased(),
-        );
-        $routeDefinitionCallback($routeCollector);
+        $routeCollector = new RouteCollector(new RouteParserStd(), new DataGeneratorGroupCountBased());
+        Routes::collect($routeCollector);
 
         $dispatchData = $routeCollector->getData();
         $canWriteCache = self::canWriteCache();
diff --git a/libraries/routes.php b/libraries/routes.php
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -9310,11 +9310,6 @@ parameters:
 			count: 1
 			path: test/classes/Properties/Options/OptionsPropertyGroupTest.php
 
-		-
-			message: "#^Call to method PHPUnit\\\\Framework\\\\Assert\\:\\:assertInstanceOf\\(\\) with 'FastRoute\\\\\\\\Dispatcher' and FastRoute\\\\Dispatcher will always evaluate to true\\.$#"
-			count: 4
-			path: test/classes/RoutingTest.php
-
 		-
 			message: "#^Call to method PHPUnit\\\\Framework\\\\Assert\\:\\:assertInstanceOf\\(\\) with 'PhpMyAdmin\\\\\\\\Server\\\\\\\\Plugin' and PhpMyAdmin\\\\Server\\\\Plugin will always evaluate to true\\.$#"
 			count: 1
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -11024,7 +11024,7 @@
       <code><![CDATA['']]></code>
     </TypeDoesNotContainType>
   </file>
-  <file src="libraries/classes/Routing.php">
+  <file src="libraries/classes/Routing/Routing.php">
     <InvalidArrayOffset>
       <code><![CDATA[$GLOBALS['cfg']['environment']]]></code>
     </InvalidArrayOffset>
@@ -14597,7 +14597,7 @@
       <code>providerForTestIsUUIDSupported</code>
     </PossiblyUnusedMethod>
   </file>
-  <file src="test/classes/RoutingTest.php">
+  <file src="test/classes/Routing/RoutingTest.php">
     <PossiblyUnusedMethod>
       <code>providerForTestCleanupPathInfo</code>
     </PossiblyUnusedMethod>
diff --git a/test/classes/Routing/RoutesTest.php b/test/classes/Routing/RoutesTest.php
diff --git a/test/classes/Routing/RoutingTest.php b/test/classes/Routing/RoutingTest.php
@@ -2,11 +2,12 @@
 
 declare(strict_types=1);
 
-namespace PhpMyAdmin\Tests;
+namespace PhpMyAdmin\Tests\Routing;
 
 use FastRoute\Dispatcher;
 use PhpMyAdmin\Controllers\HomeController;
-use PhpMyAdmin\Routing;
+use PhpMyAdmin\Routing\Routing;
+use PhpMyAdmin\Tests\AbstractTestCase;
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\DataProvider;
 
@@ -35,14 +36,12 @@ public function testGetDispatcher(): void
         // Valid cache file.
         $this->assertTrue(copy($validCacheFilename, $cacheFilename));
         $dispatcher = Routing::getDispatcher();
-        $this->assertInstanceOf(Dispatcher::class, $dispatcher);
         $this->assertSame($expected, $dispatcher->dispatch('GET', '/'));
         $this->assertFileEquals($validCacheFilename, $cacheFilename);
 
         // Invalid cache file.
         $this->assertTrue(copy($invalidCacheFilename, $cacheFilename));
         $dispatcher = Routing::getDispatcher();
-        $this->assertInstanceOf(Dispatcher::class, $dispatcher);
         $this->assertSame($expected, $dispatcher->dispatch('GET', '/'));
         $this->assertFileNotEquals($invalidCacheFilename, $cacheFilename);
 
@@ -52,14 +51,12 @@ public function testGetDispatcher(): void
         $this->assertFileDoesNotExist($cacheFilename);
 
         $dispatcher = Routing::getDispatcher();
-        $this->assertInstanceOf(Dispatcher::class, $dispatcher);
         $this->assertSame($expected, $dispatcher->dispatch('GET', '/'));
         $this->assertFileExists($cacheFilename);
 
         // Without a cache file.
         $GLOBALS['cfg']['environment'] = 'development';
         $dispatcher = Routing::getDispatcher();
-        $this->assertInstanceOf(Dispatcher::class, $dispatcher);
         $this->assertSame($expected, $dispatcher->dispatch('GET', '/'));
     }
 
