Introduce Symfony route attributes

Author: santiagolizardo

.gitignore

@@ -1,6 +1,7 @@
 vendor
 logs/*
 data/attachments/*
+data/cache/*
 data-redis
 data-mysql
 config.json

composer.json

@@ -39,7 +39,9 @@
         "symfony/mailer": "^7",
         "symfony/psr-http-message-bridge": "^7.1",
         "twig/twig": "^3.0",
-        "zircote/swagger-php": "^4.7"
+        "zircote/swagger-php": "^4.7",
+        "symfony/routing": "^7.1",
+        "doctrine/annotations": "^2.0"
     },
     "autoload": {
         "psr-4": {

composer.lock

@@ -35,7 +35,7 @@ COPY docker/api/nginx/sites-enabled/* /etc/nginx/sites-enabled/
 RUN sed -i 's/upload_max_filesize = [[:digit:]]\+M/upload_max_filesize = 20M/' /etc/php/${PHP_VERSION}/fpm/php.ini
 RUN sed -i 's/post_max_size = [[:digit:]]\+M/post_max_size = 28M/' /etc/php/${PHP_VERSION}/fpm/php.ini
 
-RUN mkdir -p /var/www/webapp /var/www/webapp/data/vendor /var/www/webapp/data/attachments /var/www/webapp/logs && \
+RUN mkdir -p /var/www/webapp /var/www/webapp/data/vendor /var/www/webapp/data/attachments /var/www/webapp/data/cache /var/www/webapp/logs && \
     chown -R reconmapper:reconmappers /var/www/webapp
 
 RUN chmod -R a+w /var/www/webapp/logs

data/cache/.gitkeep

@@ -12,10 +12,19 @@
 use Reconmap\Services\Logging\LoggingConfigurator;
 use Reconmap\Services\SearchListener;
 use Symfony\Bridge\PsrHttpMessage\Factory\HttpFoundationFactory;
+use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\Dumper\PhpDumper;
 use Symfony\Component\EventDispatcher\EventDispatcher;
+use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Exception\ResourceNotFoundException;
+use Symfony\Component\Routing\Loader\AttributeClassLoader;
+use Symfony\Component\Routing\Loader\AttributeDirectoryLoader;
+use Symfony\Component\Routing\RequestContext;
+use Symfony\Component\Routing\Route;
+use Symfony\Component\Routing\Router;
 
+// Load the configuration
 $configFilePath = $applicationDir . '/config.json';
 if (!file_exists($configFilePath) || !is_readable($configFilePath)) {
     $errorMessage = 'Missing or unreadable API configuration file (config.json)';
@@ -31,7 +40,7 @@
 $loggingConfigurator = new LoggingConfigurator($logger, $config);
 $loggingConfigurator->configure();
 
-$file = $config->getAppDir() . '/data/attachments/container.php';
+$file = $config->getAppDir() . '/data/cache/container.php';
 if (file_exists($file)) {
     require $file;
     $container = new CachedApplicationContainer();
@@ -44,22 +53,58 @@
 }
 ApplicationContainer::initialise($container, $config, $logger);
 
-$request = GuzzleHttp\Psr7\ServerRequest::fromGlobals();
-$container->set(Psr\Http\Message\ServerRequestInterface::class, $request);
+$request = Request::createFromGlobals();
+$requestContext = new RequestContext();
+$requestContext->fromRequest($request);
 
-$router = new ApiRouter();
-$router->mapRoutes($container, $config);
+$controllersDir = $applicationDir . '/src/Controllers';
 
-/**
- * @var EventDispatcher $eventDispatcher
- */
-$eventDispatcher = $container->get(EventDispatcher::class);
-$eventDispatcher->addListener(SearchEvent::class, $container->get(SearchListener::class));
+$loader = new AttributeDirectoryLoader(
+    new FileLocator([$controllersDir]),
+    new class extends AttributeClassLoader {
+        protected function configureRoute(Route $route, \ReflectionClass $class, \ReflectionMethod $method, object $annot): void
+        {
+            $route->setDefault('_controller', $class->name . '::' . $method->name);
+        }
+    }
+);
 
-$response = $router->dispatch($request);
+$routes = $loader->load($controllersDir);
+$router = new Router(
+    $loader,
+    $controllersDir,
+    ['cache_dir' => $applicationDir . '/data/cache', 'debug' => false],
+    $requestContext
+);
 
-$httpFoundationFactory = new HttpFoundationFactory();
-$symfonyResponse = $httpFoundationFactory->createResponse($response);
+try {
+    // Try routing the request with Symfony's Router
+    $parameters = $router->match($request->getPathInfo());
+    $controller = $parameters['_controller'];
+    unset($parameters['_controller'], $parameters['_route']);
 
-$symfonyResponse->send();
+    // Call the matched controller
+    [$class, $method] = explode('::', $controller, 2);
+    $ooo = $container->get($class);
+    $response = call_user_func_array([$ooo, $method], $parameters);
+} catch (ResourceNotFoundException $e) {
+    // Fall back to the custom API router
+    $guzzleRequest = GuzzleHttp\Psr7\ServerRequest::fromGlobals();
+    $container->set(Psr\Http\Message\ServerRequestInterface::class, $guzzleRequest);
 
+    $apiRouter = new ApiRouter();
+    $apiRouter->mapRoutes($container, $config);
+
+    /**
+     * @var EventDispatcher $eventDispatcher
+     */
+    $eventDispatcher = $container->get(EventDispatcher::class);
+    $eventDispatcher->addListener(SearchEvent::class, $container->get(SearchListener::class));
+
+    $apiResponse = $apiRouter->dispatch($guzzleRequest);
+
+    $httpFoundationFactory = new HttpFoundationFactory();
+    $response = $httpFoundationFactory->createResponse($apiResponse);
+}
+
+$response->send();

docker/api/Dockerfile

@@ -84,7 +84,6 @@ public function mapRoutes(ContainerInterface $container, ApplicationConfig $appl
         $securityMiddleware = $container->get(SecurityMiddleware::class);
         $cookieMiddleware = $container->get(StaticMiddleware::class);
 
-        $this->map('GET', '/openapi.json', GetOpenApiYamlController::class);
         $this->map('GET', '/image/{attachmentId:number}', ServeAttachmentController::class)->middlewares([$cookieMiddleware]);
 
         $this->group('', function (RouteGroup $router): void {