feat: Add response to CacheRuleEvent to check also for example status code

Author: lochmueller

Classes/Cache/Listener/ValidResponseCodeListener.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SFC\Staticfilecache\Cache\Listener;
+
+use SFC\Staticfilecache\Event\CacheRuleEvent;
+
+class ValidResponseCodeListener
+{
+    public function __invoke(CacheRuleEvent $event): void
+    {
+        $validStatusCodes = [200];
+        $responseStatusCode = $event->getResponse()->getStatusCode();
+
+        if (!in_array($responseStatusCode, $validStatusCodes)) {
+            $event->addExplanation(__CLASS__, 'The Status code ist not valid');
+            $event->setSkipProcessing(true);
+        }
+    }
+}

Classes/Event/CacheRuleEvent.php

@@ -4,21 +4,28 @@
 
 namespace SFC\Staticfilecache\Event;
 
+use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
 
 final class CacheRuleEvent implements CacheRuleEventInterface
 {
     public function __construct(
         readonly private ServerRequestInterface $request,
         private array $explanation,
-        private bool $skipProcessing
+        private bool $skipProcessing,
+        readonly private ResponseInterface $response,
     ) {}
 
     public function getRequest(): ServerRequestInterface
     {
         return $this->request;
     }
 
+    public function getResponse(): ResponseInterface
+    {
+        return $this->response;
+    }
+
     public function getExplanation(): array
     {
         return $this->explanation;

Classes/Middleware/PrepareMiddleware.php

@@ -41,7 +41,7 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface
         $explanation = [];
         $skipProcessing = false;
 
-        $event = new CacheRuleEvent($request, $explanation, $skipProcessing);
+        $event = new CacheRuleEvent($request, $explanation, $skipProcessing, $response);
         $this->eventDispatcher->dispatch($event);
 
         if (!$event->isSkipProcessing()) {

Configuration/Services.yaml

@@ -46,6 +46,13 @@ services:
         identifier: 'ValidUriListenerFallback'
         event: SFC\Staticfilecache\Event\CacheRuleFallbackEvent
 
+  SFC\Staticfilecache\Cache\Listener\ValidResponseCodeListener:
+    tags:
+      - name: event.listener
+        identifier: 'ValidResponseCodeListener'
+        event: SFC\Staticfilecache\Event\CacheRuleEvent
+        before: 'ForceStaticCacheListener'
+
   SFC\Staticfilecache\Cache\Listener\SolrIndexingProcessListener:
     tags:
       - name: event.listener