Adding afterRouteMiddlewares configuration option

README.md

@@ -72,6 +72,10 @@ parameters:
                                 - App\UsuallyRequestDataValidationMiddleware # second in row
                                 - App\SomeAuthMiddleware # this one is called first 
 
+        afterRouteMiddlewares:
+            # this is called for each route, after the route middlewares
+            - App\SomeAfterRequestMiddleware 
+
         beforeRouteMiddlewares:
             # this is called for each route, before route middlewares
             - App\SomeBeforeRequestMiddleware 

composer.json

@@ -36,6 +36,9 @@
     "prefer-stable": true,
     "config": {
         "sort-packages": true,
-        "process-timeout": 600
+        "process-timeout": 600,
+        "allow-plugins": {
+            "dealerdirect/phpcodesniffer-composer-installer": true
+        }
     }
 }

src/SlimApplicationFactory.php

@@ -31,6 +31,11 @@ final class SlimApplicationFactory
      */
     private $beforeRoutesMiddlewares;
 
+    /**
+     * @var array<Middleware>
+     */
+    private $afterRoutesMiddlewares;
+
 
     /**
      * @param mixed[]   $configuration
@@ -40,6 +45,7 @@ public function __construct(array $configuration, Container $container)
         $this->configuration = $configuration;
         $this->container = $container;
         $this->beforeRoutesMiddlewares = [];
+        $this->afterRoutesMiddlewares = [];
     }
 
 
@@ -49,6 +55,7 @@ public function create(): SlimApp
 
         $configuration = $this->getConfiguration($this->configuration['apiDefinitionKey']);
 
+        $this->registerAfterRouteMiddlewares($app, $configuration);
         $this->registerBeforeRouteMiddlewares($app, $configuration);
 
         foreach ($configuration['routes'] as $apiName => $api) {
@@ -123,6 +130,8 @@ private function validateConfiguration(
 
 
     /**
+     * @param class-string $serviceName
+     *
      * @return Closure
      */
     private function getServiceProvider(string $serviceName): callable
@@ -161,6 +170,9 @@ private function registerHandlers(SlimApp $app, array $handlers): void
     }
 
 
+    /**
+     * @param class-string $serviceName
+     */
     private function registerServiceIntoContainer(SlimApp $app, string $serviceName): void
     {
         if (!$app->getContainer()->has($serviceName)) {
@@ -224,6 +236,10 @@ private function registerInvokableActionRoutes(SlimApp $app, array $routeData, s
             $this->registerServiceIntoContainer($app, $service);
             $routeToAdd = $app->map([$method], $urlPattern, $service);
 
+            foreach ($this->afterRoutesMiddlewares as $middleware) {
+                $routeToAdd->add($middleware);
+            }
+
             if (isset($config['middleware'])) {
                 foreach ($config['middleware'] as $middleware) {
                     $this->registerServiceIntoContainer($app, $middleware);
@@ -261,6 +277,9 @@ private function createUrlPattern(string $apiName, string $version, string $rout
     }
 
 
+    /**
+     * @param class-string $middleware
+     */
     private function registerBeforeRequestMiddleware(SlimApp $app, string $middleware): void
     {
         $this->registerServiceIntoContainer($app, $middleware);
@@ -280,4 +299,18 @@ private function registerBeforeRouteMiddlewares(SlimApp $app, array $configurati
             }
         }
     }
+
+
+    /**
+     * @param mixed[] $configuration
+     */
+    private function registerAfterRouteMiddlewares(SlimApp $app, array $configuration): void
+    {
+        if (isset($configuration['afterRouteMiddlewares'])) {
+            foreach ($configuration['afterRouteMiddlewares'] as $globalMiddleware) {
+                $this->registerServiceIntoContainer($app, $globalMiddleware);
+                $this->afterRoutesMiddlewares[] = $app->getContainer()->get($globalMiddleware);
+            }
+        }
+    }
 }

tests/Request/RequestTest.php

@@ -30,9 +30,9 @@ public function testShouldDistinguishBetweenNullAndEmptyOption(): void
     {
         $request = $this->createSampleRequest();
 
-        self::assertTrue($request->hasField('thisIsNull'));
-        self::assertFalse($request->hasField('nonExistingField'));
-        self::assertTrue($request->hasField('thisIsGandalf'));
+        Assert::assertTrue($request->hasField('thisIsNull'));
+        Assert::assertFalse($request->hasField('nonExistingField'));
+        Assert::assertTrue($request->hasField('thisIsGandalf'));
     }
 
 
@@ -53,7 +53,7 @@ public function testShouldRaiseExceptionForMissingRequiredField(): void
     {
         $request = $this->createSampleRequest();
 
-        self::assertEquals('gandalf', $request->getField('thisIsGandalf'));
+        Assert::assertEquals('gandalf', $request->getField('thisIsGandalf'));
         $this->expectException(MissingApiArgumentException::class);
         $request->getField('nonExistingField');
     }
@@ -67,7 +67,7 @@ public function testGettingDateTimeQueryParam(): void
         $request = new Request($slimRequest);
         $dateTime = $request->getDateTimeQueryParam(self::PARAM_NAME);
 
-        self::assertSame(self::DATE_TIME_STRING, $dateTime->format(DateTime::ATOM));
+        Assert::assertSame(self::DATE_TIME_STRING, $dateTime->format(DateTime::ATOM));
     }
 
 

tests/Sample/AfterRouteMiddleware.php

@@ -0,0 +1,20 @@
+<?php declare(strict_types = 1);
+
+namespace BrandEmbassyTest\Slim\Sample;
+
+use BrandEmbassy\Slim\Middleware;
+use BrandEmbassy\Slim\Request\RequestInterface;
+use BrandEmbassy\Slim\Response\ResponseInterface;
+
+class AfterRouteMiddleware implements Middleware
+{
+    public function __invoke(RequestInterface $request, ResponseInterface $response, callable $next): ResponseInterface
+    {
+        $response = $response->withHeader(
+            'header-to-be-changed-by-after-route-middleware',
+            'changed-value'
+        );
+
+        return $next($request, $response);
+    }
+}

tests/Sample/BeforeRouteMiddleware.php

@@ -10,6 +10,10 @@ class BeforeRouteMiddleware implements Middleware
 {
     public function __invoke(RequestInterface $request, ResponseInterface $response, callable $next): ResponseInterface
     {
+        $response = $response->withAddedHeader(
+            'header-to-be-changed-by-after-route-middleware',
+            'initial-value'
+        );
         $response = $response->withAddedHeader(
             'processed-by-before-route-middlewares',
             'proof-for-before-route'

tests/SlimApplicationFactoryTest.php

@@ -104,7 +104,11 @@ public function routeResponseDataProvider(): array
 
     public function testShouldProcessBothGlobalMiddlewares(): void
     {
-        $request = $this->createRequest('POST', '/new-api/2.0/channels');
+        $request = $this->createRequest(
+            'POST',
+            '/new-api/2.0/channels',
+            ['goldenKey' => GoldenKeyAuthMiddleware::ACCESS_TOKEN]
+        );
 
         /** @var ResponseInterface $response */
         $response = $this->createSlimApp()->process($request, new Response(new \Slim\Http\Response()));
@@ -118,6 +122,11 @@ public function testShouldProcessBothGlobalMiddlewares(): void
             ['proof-for-before-route'],
             $response->getHeader('processed-by-before-route-middlewares')
         );
+
+        Assert::assertSame(
+            ['changed-value'],
+            $response->getHeader('header-to-be-changed-by-after-route-middleware')
+        );
     }
 
 

tests/config.neon

@@ -12,6 +12,7 @@ services:
     - BrandEmbassyTest\Slim\Sample\ErroringAction
     - BrandEmbassyTest\Slim\Sample\BeforeRequestMiddleware
     - BrandEmbassyTest\Slim\Sample\BeforeRouteMiddleware
+    - BrandEmbassyTest\Slim\Sample\AfterRouteMiddleware
 
 parameters:
     api:
@@ -40,6 +41,9 @@ parameters:
                         post:
                             service: BrandEmbassyTest\Slim\Sample\ErroringAction
 
+        afterRouteMiddlewares:
+            - BrandEmbassyTest\Slim\Sample\AfterRouteMiddleware
+
         beforeRouteMiddlewares:
             - BrandEmbassyTest\Slim\Sample\BeforeRouteMiddleware