Refactor routes (#236)

Author: vjik

composer-dependency-analyser.php

@@ -14,8 +14,11 @@
     ->addPathToScan($root . '/public/index.php', isDev: false)
     ->addPathToScan($root . '/yii', isDev: false)
     ->addPathToScan($root . '/tests', isDev: true)
-    ->ignoreErrorsOnPackage('psr/container', [ErrorType::PROD_DEPENDENCY_ONLY_IN_DEV])
-    ->ignoreErrorsOnPackage('yiisoft/di', [ErrorType::UNUSED_DEPENDENCY])
-    ->ignoreErrorsOnPackage('yiisoft/config', [ErrorType::PROD_DEPENDENCY_ONLY_IN_DEV])
-    ->ignoreErrorsOnPackage('yiisoft/yii-event', [ErrorType::PROD_DEPENDENCY_ONLY_IN_DEV])
-    ->ignoreErrorsOnPackage('yiisoft/router-fastroute', [ErrorType::UNUSED_DEPENDENCY]);
+    ->ignoreErrorsOnPackages(
+        ['psr/container', 'yiisoft/config', 'yiisoft/yii-event', 'yiisoft/yii-event'],
+        [ErrorType::PROD_DEPENDENCY_ONLY_IN_DEV],
+    )
+    ->ignoreErrorsOnPackages(
+        ['yiisoft/di', 'yiisoft/aliases', 'yiisoft/request-provider', 'yiisoft/router-fastroute'],
+        [ErrorType::UNUSED_DEPENDENCY],
+    );

composer.json

@@ -39,12 +39,13 @@
         "psr/http-server-middleware": "^1.0.2",
         "psr/log": "^3.0.2",
         "symfony/console": "^7.3.3",
+        "yiisoft/aliases": "^3.1",
         "yiisoft/config": "^1.6",
         "yiisoft/data": "^1.0.1",
         "yiisoft/data-response": "^2.1.1",
         "yiisoft/definitions": "^3.4",
         "yiisoft/di": "^1.4",
-        "yiisoft/error-handler": "^4.2",
+        "yiisoft/error-handler": "^4.3",
         "yiisoft/http": "^1.2",
         "yiisoft/hydrator": "^1.6.1",
         "yiisoft/input-http": "^1.0.1",
@@ -57,8 +58,7 @@
         "yiisoft/router-fastroute": "^4.0.1",
         "yiisoft/yii-console": "^2.3",
         "yiisoft/yii-event": "^2.1",
-        "yiisoft/yii-http": "^1.0.4",
-        "yiisoft/yii-middleware": "^1.1",
+        "yiisoft/yii-http": "^1.1.0",
         "yiisoft/yii-runner-console": "^2.2",
         "yiisoft/yii-runner-http": "^3.2"
     },
@@ -69,11 +69,11 @@
         "codeception/module-asserts": "^3.2",
         "codeception/module-cli": "^2.0.1",
         "codeception/module-db": "^3.2.2",
-        "codeception/module-phpbrowser": "^3.0.1",
+        "codeception/module-phpbrowser": "^3.0.2",
         "codeception/module-rest": "^3.4.1",
-        "friendsofphp/php-cs-fixer": "^3.87",
-        "phpunit/phpunit": "^11.5.35",
-        "rector/rector": "^2.1.4",
+        "friendsofphp/php-cs-fixer": "^3.87.1",
+        "phpunit/phpunit": "^11.5.36",
+        "rector/rector": "^2.1.6",
         "roave/infection-static-analysis-plugin": "^1.39",
         "shipmonk/composer-dependency-analyser": "^1.8.3",
         "vimeo/psalm": "^6.13.1",

config/common/di/router.php

@@ -2,24 +2,16 @@
 
 declare(strict_types=1);
 
-use App\Http\ExceptionMiddleware;
 use Yiisoft\Config\Config;
-use Yiisoft\DataResponse\Middleware\FormatDataResponse;
-use Yiisoft\Request\Body\RequestBodyParser;
 use Yiisoft\Router\RouteCollection;
 use Yiisoft\Router\RouteCollectionInterface;
 use Yiisoft\Router\RouteCollectorInterface;
 
 /** @var Config $config */
 
 return [
-    RouteCollectionInterface::class => static function (RouteCollectorInterface $collector) use ($config) {
-        $collector
-            ->middleware(RequestBodyParser::class)
-            ->middleware(FormatDataResponse::class)
-            ->middleware(ExceptionMiddleware::class)
-            ->addRoute(...$config->get('routes'));
-
-        return new RouteCollection($collector);
-    },
+    RouteCollectionInterface::class =>
+        static fn(RouteCollectorInterface $collector) => new RouteCollection(
+            $collector->addRoute(...$config->get('routes')),
+        ),
 ];

config/configuration.php

@@ -34,9 +34,7 @@
         'bootstrap' => [],
         'bootstrap-console' => '$bootstrap',
         'bootstrap-web' => '$bootstrap',
-        'routes' => [
-            'common/routes.php',
-        ],
+        'routes' => 'common/routes.php',
     ],
     'config-plugin-environments' => [
         Environment::DEV => [

config/web/di/application.php

@@ -2,7 +2,10 @@
 
 declare(strict_types=1);
 
-use App\Http\NotFoundHandler;
+use App\Http\ApiResponseFormatter;
+use App\Http\ExceptionMiddleware;
+use App\Http\NotFoundMiddleware;
+use Yiisoft\DataResponse\Middleware\FormatDataResponse;
 use Yiisoft\Definitions\DynamicReference;
 use Yiisoft\Definitions\Reference;
 use Yiisoft\ErrorHandler\Middleware\ErrorCatcher;
@@ -11,10 +14,9 @@
 use Yiisoft\Middleware\Dispatcher\CompositeParametersResolver;
 use Yiisoft\Middleware\Dispatcher\MiddlewareDispatcher;
 use Yiisoft\Middleware\Dispatcher\ParametersResolverInterface;
-use Yiisoft\RequestProvider\RequestCatcherMiddleware;
+use Yiisoft\Request\Body\RequestBodyParser;
 use Yiisoft\Router\Middleware\Router;
 use Yiisoft\Yii\Http\Application;
-use Yiisoft\Yii\Middleware\Subfolder;
 
 /** @var array $params */
 
@@ -25,14 +27,15 @@
                 'class' => MiddlewareDispatcher::class,
                 'withMiddlewares()' => [
                     [
-                        RequestCatcherMiddleware::class,
+                        static fn(ApiResponseFormatter $formatter) => new FormatDataResponse($formatter),
+                        RequestBodyParser::class,
+                        ExceptionMiddleware::class,
                         ErrorCatcher::class,
-                        Subfolder::class,
                         Router::class,
+                        NotFoundMiddleware::class,
                     ],
                 ],
             ]),
-            'fallbackHandler' => Reference::to(NotFoundHandler::class),
         ],
     ],
 

config/web/di/data-response.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Http;
+
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+use Psr\Http\Server\MiddlewareInterface;
+use Psr\Http\Server\RequestHandlerInterface;
+use Yiisoft\DataResponse\DataResponseFactoryInterface;
+use Yiisoft\Http\Status;
+
+final readonly class NotFoundMiddleware implements MiddlewareInterface
+{
+    public function __construct(
+        private DataResponseFactoryInterface $dataResponseFactory,
+    ) {}
+
+    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
+    {
+        return $this->dataResponseFactory->createResponse(
+            'Not found.',
+            Status::NOT_FOUND,
+        );
+    }
+}