From 1462c27461f68555132486e2517ff3e491a49039 Mon Sep 17 00:00:00 2001
From: Arthur Perton <arthur@webenapp.nl>
Date: Wed, 18 Dec 2024 22:40:28 +0100
Subject: [PATCH] [5.x] Static warm: recheck whether page is cached for queued
 requests (#11273)

---
 src/Console/Commands/StaticWarm.php           |  6 ++-
 .../Commands/StaticWarmUncachedJob.php        | 20 +++++++
 tests/Console/Commands/StaticWarmTest.php     | 54 +++++++++++++++++++
 .../Commands/StaticWarmUncachedJobTest.php    | 53 ++++++++++++++++++
 4 files changed, 132 insertions(+), 1 deletion(-)
 create mode 100644 src/Console/Commands/StaticWarmUncachedJob.php
 create mode 100644 tests/Console/Commands/StaticWarmUncachedJobTest.php

diff --git a/src/Console/Commands/StaticWarm.php b/src/Console/Commands/StaticWarm.php
index 909d6043ce..a7a052df15 100644
--- a/src/Console/Commands/StaticWarm.php
+++ b/src/Console/Commands/StaticWarm.php
@@ -95,8 +95,12 @@ private function warm(): void
             $queue = config('statamic.static_caching.warm_queue');
             $this->line(sprintf('Adding %s requests onto %squeue...', count($requests), $queue ? $queue.' ' : ''));
 
+            $jobClass = $this->option('uncached')
+                ? StaticWarmUncachedJob::class
+                : StaticWarmJob::class;
+
             foreach ($requests as $request) {
-                StaticWarmJob::dispatch($request, $this->clientConfig())
+                $jobClass::dispatch($request, $this->clientConfig())
                     ->onConnection($this->queueConnection)
                     ->onQueue($queue);
             }
diff --git a/src/Console/Commands/StaticWarmUncachedJob.php b/src/Console/Commands/StaticWarmUncachedJob.php
new file mode 100644
index 0000000000..11c0c246d6
--- /dev/null
+++ b/src/Console/Commands/StaticWarmUncachedJob.php
@@ -0,0 +1,20 @@
+<?php
+
+namespace Statamic\Console\Commands;
+
+use Illuminate\Http\Request;
+use Statamic\StaticCaching\Cacher;
+
+class StaticWarmUncachedJob extends StaticWarmJob
+{
+    public function handle()
+    {
+        $cacher = app(Cacher::class);
+
+        if ($cacher->hasCachedPage(Request::create($this->request->getUri()))) {
+            return;
+        }
+
+        parent::handle();
+    }
+}
diff --git a/tests/Console/Commands/StaticWarmTest.php b/tests/Console/Commands/StaticWarmTest.php
index db9ce453e2..344fdff0bc 100644
--- a/tests/Console/Commands/StaticWarmTest.php
+++ b/tests/Console/Commands/StaticWarmTest.php
@@ -8,6 +8,7 @@
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\Attributes\Test;
 use Statamic\Console\Commands\StaticWarmJob;
+use Statamic\Console\Commands\StaticWarmUncachedJob;
 use Statamic\Facades\Collection;
 use Statamic\StaticCaching\Cacher;
 use Tests\PreventSavingStacheItemsToDisk;
@@ -183,6 +184,59 @@ public function it_queues_the_requests()
         });
     }
 
+    #[Test]
+    public function it_queues_the_request_when_the_uncached_option_is_used()
+    {
+        config([
+            'statamic.static_caching.strategy' => 'half',
+            'queue.default' => 'redis',
+        ]);
+
+        Queue::fake();
+
+        $this->artisan('statamic:static:warm', ['--queue' => true, '--uncached' => true])
+            ->expectsOutputToContain('Adding 2 requests')
+            ->assertExitCode(0);
+
+        Queue::assertCount(2);
+
+        Queue::assertPushed(StaticWarmUncachedJob::class, function ($job) {
+            return $job->request->getUri()->getPath() === '/about';
+        });
+        Queue::assertPushed(StaticWarmUncachedJob::class, function ($job) {
+            return $job->request->getUri()->getPath() === '/contact';
+        });
+    }
+
+    #[Test]
+    public function it_doesnt_queue_the_request_when_the_uncached_option_is_used_and_the_page_is_cached()
+    {
+        config([
+            'statamic.static_caching.strategy' => 'half',
+            'queue.default' => 'redis',
+        ]);
+
+        $mock = Mockery::mock(Cacher::class);
+        $mock->shouldReceive('hasCachedPage')->times(2)->andReturn(true, false);
+        $mock->allows('isExcluded')->andReturn(false);
+        app()->instance(Cacher::class, $mock);
+
+        Queue::fake();
+
+        $this->artisan('statamic:static:warm', ['--queue' => true, '--uncached' => true])
+            ->expectsOutputToContain('Adding 1 requests')
+            ->assertExitCode(0);
+
+        Queue::assertCount(1);
+
+        Queue::assertNotPushed(StaticWarmUncachedJob::class, function ($job) {
+            return $job->request->getUri()->getPath() === '/about';
+        });
+        Queue::assertPushed(StaticWarmUncachedJob::class, function ($job) {
+            return $job->request->getUri()->getPath() === '/contact';
+        });
+    }
+
     #[Test, DataProvider('queueConnectionsProvider')]
     public function it_queues_the_requests_with_appropriate_queue_and_connection(
         $configuredQueue,
diff --git a/tests/Console/Commands/StaticWarmUncachedJobTest.php b/tests/Console/Commands/StaticWarmUncachedJobTest.php
new file mode 100644
index 0000000000..5b5459a53b
--- /dev/null
+++ b/tests/Console/Commands/StaticWarmUncachedJobTest.php
@@ -0,0 +1,53 @@
+<?php
+
+namespace Tests\Console\Commands;
+
+use GuzzleHttp\Handler\MockHandler;
+use GuzzleHttp\HandlerStack;
+use GuzzleHttp\Psr7\Request;
+use GuzzleHttp\Psr7\Response;
+use Mockery;
+use PHPUnit\Framework\Attributes\Test;
+use Statamic\Console\Commands\StaticWarmUncachedJob;
+use Statamic\StaticCaching\Cacher;
+use Tests\TestCase;
+
+class StaticWarmUncachedJobTest extends TestCase
+{
+    #[Test]
+    public function it_sends_a_get_request()
+    {
+        $mock = new MockHandler([
+            new Response(200),
+        ]);
+
+        $handlerStack = HandlerStack::create($mock);
+
+        $job = new StaticWarmUncachedJob(new Request('GET', '/about'), ['handler' => $handlerStack]);
+
+        $job->handle();
+
+        $this->assertEquals('/about', $mock->getLastRequest()->getUri()->getPath());
+    }
+
+    #[Test]
+    public function it_does_not_send_a_request_if_the_page_is_cached()
+    {
+        $mockCacher = Mockery::mock(Cacher::class);
+        $mockCacher->shouldReceive('hasCachedPage')->once()->andReturn(true);
+        $mockCacher->allows('isExcluded')->andReturn(false);
+        app()->instance(Cacher::class, $mockCacher);
+
+        $mock = new MockHandler([
+            new Response(200),
+        ]);
+
+        $handlerStack = HandlerStack::create($mock);
+
+        $job = new StaticWarmUncachedJob(new Request('GET', '/about'), ['handler' => $handlerStack]);
+
+        $job->handle();
+
+        $this->assertNull($mock->getLastRequest());
+    }
+}