Fix: defer cache storage to terminate() to include post-response modifications (#513)

eguiluz · David Eguiluz López · freekmurze · web-flow · commit 7f5be3671307 · 2026-03-03T20:51:38.000+01:00
* Defer cache storage to terminate() to include post-response modifications

* Remove comments from changed code

Co-Authored-By: Claude Opus 4.6 &lt;noreply@anthropic.com&gt;

---------

Co-authored-by: David Eguiluz López &lt;davidel@raiolanetworks.es&gt;
Co-authored-by: Freek Van der Herten &lt;freek@spatie.be&gt;
Co-authored-by: Claude Opus 4.6 &lt;noreply@anthropic.com&gt;
diff --git a/src/Middlewares/CacheResponse.php b/src/Middlewares/CacheResponse.php
@@ -19,6 +19,13 @@
 
 class CacheResponse extends BaseCacheMiddleware
 {
+    private bool $shouldCache = false;
+
+    private ?int $pendingLifetime = null;
+
+    /** @var string[] */
+    private array $pendingTags = [];
+
     public function __construct(
         protected ResponseCache $responseCache,
     ) {}
@@ -41,6 +48,10 @@ public static function for(
 
     public function handle(Request $request, Closure $next, ...$args): Response
     {
+        $this->shouldCache = false;
+        $this->pendingLifetime = null;
+        $this->pendingTags = [];
+
         $attribute = $this->getAttributeFromRequest($request);
 
         if ($attribute instanceof NoCache) {
@@ -69,7 +80,9 @@ public function handle(Request $request, Closure $next, ...$args): Response
         $response = $next($request);
 
         if ($this->responseCache->shouldCache($request, $response)) {
-            $this->cacheResponse($request, $response, $lifetimeInSeconds, $tags);
+            $this->shouldCache = true;
+            $this->pendingLifetime = $lifetimeInSeconds;
+            $this->pendingTags = $tags;
         }
 
         $cacheKey = app(RequestHasher::class)->getHashFor($request);
@@ -80,6 +93,15 @@ public function handle(Request $request, Closure $next, ...$args): Response
         return $response;
     }
 
+    public function terminate(Request $request, Response $response): void
+    {
+        if (! $this->shouldCache) {
+            return;
+        }
+
+        $this->cacheResponse($request, $response, $this->pendingLifetime, $this->pendingTags);
+    }
+
     protected function getCachedResponse(Request $request, array $tags): ?Response
     {
         if (! $this->responseCache->hasBeenCached($request, $tags)) {
@@ -115,6 +137,8 @@ protected function cacheResponse(
     ): void {
         $cachedResponse = clone $response;
 
+        $cachedResponse->headers->remove(config('responsecache.debug.cache_status_header_name'));
+
         $this->addCacheTimeHeader($cachedResponse);
 
         $this->getReplacers()->each(fn (Replacer $replacer) => $replacer->prepareResponseToCache($cachedResponse));
diff --git a/src/ResponseCacheServiceProvider.php b/src/ResponseCacheServiceProvider.php
@@ -9,6 +9,7 @@
 use Spatie\ResponseCache\CacheProfiles\CacheProfile;
 use Spatie\ResponseCache\Commands\ClearCommand;
 use Spatie\ResponseCache\Hasher\RequestHasher;
+use Spatie\ResponseCache\Middlewares\CacheResponse;
 use Spatie\ResponseCache\Serializers\Serializer;
 
 class ResponseCacheServiceProvider extends PackageServiceProvider
@@ -25,6 +26,8 @@ public function configurePackage(Package $package): void
 
     public function packageBooted()
     {
+        $this->app->singleton(CacheResponse::class);
+
         $this->app->bind(CacheProfile::class, function (Container $app) {
             return $app->make(config('responsecache.cache_profile'));
         });
diff --git a/tests/RequestHandledIntegrationTest.php b/tests/RequestHandledIntegrationTest.php
@@ -0,0 +1,38 @@
+<?php
+
+use Illuminate\Foundation\Http\Events\RequestHandled;
+use Illuminate\Support\Facades\Route;
+use Spatie\ResponseCache\Middlewares\CacheResponse;
+
+it('includes modifications made by RequestHandled listeners in the cached response', function () {
+    $rendered = false;
+
+    Route::get('/with-listener', function () use (&$rendered) {
+        $rendered = true;
+
+        return '<html><head></head><body>page content</body></html>';
+    })->middleware(CacheResponse::class);
+
+    app('events')->listen(RequestHandled::class, function ($handled) use (&$rendered) {
+        if (! $rendered) {
+            return;
+        }
+
+        $rendered = false;
+
+        $content = $handled->response->getContent();
+        $handled->response->setContent(
+            str_replace('</head>', '<script src="livewire.js"></script></head>', $content)
+        );
+    });
+
+    $firstResponse = $this->get('/with-listener');
+    assertRegularResponse($firstResponse);
+    expect($firstResponse->getContent())->toContain('<script src="livewire.js"></script>');
+
+    $secondResponse = $this->get('/with-listener');
+    assertCachedResponse($secondResponse);
+    expect($secondResponse->getContent())->toContain('<script src="livewire.js"></script>');
+
+    assertSameResponse($firstResponse, $secondResponse);
+});
