Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
],
"require": {
"php": "^8.0",
"statamic/cms": "^5.0"
"statamic/cms": "^5.0|^6.0"
},
"require-dev": {
"pestphp/pest": "^3.0",
Expand Down
11 changes: 11 additions & 0 deletions src/Events/CachePurged.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<?php

namespace Eminos\StatamicCloudflareCache\Events;

class CachePurged
{
public function __construct(
public array $urls,
public bool $purgedEverything
) {}
}
3 changes: 3 additions & 0 deletions src/Jobs/PurgeCloudflareCacheJob.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

namespace Eminos\StatamicCloudflareCache\Jobs;

use Eminos\StatamicCloudflareCache\Events\CachePurged;
use Eminos\StatamicCloudflareCache\Http\Client;
use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
Expand Down Expand Up @@ -39,11 +40,13 @@ public function handle(Client $client): void
Log::debug('[Cloudflare Cache] Queued job purging everything.');
}
$client->purgeEverything();
event(new CachePurged([], true));
} elseif (! empty($this->urls)) {
if (config('cloudflare-cache.debug')) {
Log::debug('[Cloudflare Cache] Queued job purging URLs: ' . implode(', ', $this->urls));
}
$client->purgeUrls($this->urls);
event(new CachePurged($this->urls, false));
} else {
// This case should ideally not happen if dispatched correctly (null vs empty array)
// but we log it just in case.
Expand Down
3 changes: 3 additions & 0 deletions src/Listeners/PurgeCloudflareCache.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

namespace Eminos\StatamicCloudflareCache\Listeners;

use Eminos\StatamicCloudflareCache\Events\CachePurged;
use Eminos\StatamicCloudflareCache\Jobs\PurgeCloudflareCacheJob; // Updated job import namespace
use Eminos\StatamicCloudflareCache\Http\Client; // Updated client import namespace
use Statamic\Events\Event;
Expand Down Expand Up @@ -86,6 +87,7 @@ protected function purgeSynchronously(array $urls): void
Log::debug('[Cloudflare Cache] Synchronously purging URLs: ' . implode(', ', $urls));
}
$this->client->purgeUrls($urls);
event(new CachePurged($urls, false));
return;
}

Expand All @@ -94,6 +96,7 @@ protected function purgeSynchronously(array $urls): void
Log::debug('[Cloudflare Cache] Synchronously purging everything.');
}
$this->client->purgeEverything();
event(new CachePurged([], true));
}
}

Expand Down
79 changes: 79 additions & 0 deletions tests/Feature/PurgeCacheJobTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
<?php

namespace Eminos\StatamicCloudflareCache\Tests\Feature;

use Eminos\StatamicCloudflareCache\Events\CachePurged;
use Eminos\StatamicCloudflareCache\Http\Client;
use Eminos\StatamicCloudflareCache\Jobs\PurgeCloudflareCacheJob;
use Eminos\StatamicCloudflareCache\Tests\TestCase;
use Illuminate\Support\Facades\Event;
use Illuminate\Support\Facades\Http;
use PHPUnit\Framework\Attributes\Test;

class PurgeCacheJobTest extends TestCase
{
public function setUp(): void
{
parent::setUp();

Http::fake([
'https://api.cloudflare.com/client/v4/zones/*/purge_cache' => Http::response([
'success' => true,
], 200),
]);
}

#[Test]
public function it_fires_cache_purged_event_after_purging_specific_urls()
{
Event::fake();
config(['cloudflare-cache.enabled' => true]);

$urls = ['http://test.com/page1', 'http://test.com/page2'];
$job = new PurgeCloudflareCacheJob($urls);

$clientMock = $this->mock(Client::class);
$clientMock->shouldReceive('purgeUrls')->once()->with($urls);

$job->handle($clientMock);

Event::assertDispatched(CachePurged::class, function ($e) use ($urls) {
return $e->urls === $urls && !$e->purgedEverything;
});
}

#[Test]
public function it_fires_cache_purged_event_after_purging_everything()
{
Event::fake();
config(['cloudflare-cache.enabled' => true]);

$job = new PurgeCloudflareCacheJob(null);

$clientMock = $this->mock(Client::class);
$clientMock->shouldReceive('purgeEverything')->once();

$job->handle($clientMock);

Event::assertDispatched(CachePurged::class, function ($e) {
return $e->purgedEverything && empty($e->urls);
});
}

#[Test]
public function it_does_not_fire_event_when_cache_is_disabled()
{
Event::fake();
config(['cloudflare-cache.enabled' => false]);

$job = new PurgeCloudflareCacheJob(['http://test.com/page']);

$clientMock = $this->mock(Client::class);
$clientMock->shouldNotReceive('purgeUrls');
$clientMock->shouldNotReceive('purgeEverything');

$job->handle($clientMock);

Event::assertNotDispatched(CachePurged::class);
}
}
46 changes: 46 additions & 0 deletions tests/Feature/PurgeCacheListenerTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,10 @@
use Statamic\Events\GlobalSetDeleted;
use Statamic\Contracts\Entries\Entry;
use Statamic\Contracts\Entries\Collection;
use Illuminate\Support\Facades\Event;
use Illuminate\Support\Facades\Http;
use Illuminate\Support\Facades\Queue; // Add Queue facade
use Eminos\StatamicCloudflareCache\Events\CachePurged;
use Eminos\StatamicCloudflareCache\Jobs\PurgeCloudflareCacheJob;
use Mockery;
use PHPUnit\Framework\Attributes\Test;
Expand Down Expand Up @@ -309,4 +311,48 @@ public function it_does_not_purge_when_global_set_saved_event_is_disabled_in_con
Queue::assertNothingPushed();
Http::assertNothingSent();
}

#[Test]
public function it_fires_cache_purged_event_after_synchronous_purge_with_urls()
{
Event::fake();
config(['cloudflare-cache.queue_purge' => false]);

$entry = $this->mockEntry('http://test.com/entry', 'http://test.com/collection');
$event = new EntrySaved($entry);

$clientMock = $this->mock(Client::class);
$clientMock->shouldReceive('purgeUrls')->once();

$listener = $this->app->make(PurgeCloudflareCache::class);
$listener->handle($event);

Event::assertDispatched(CachePurged::class, function ($e) {
return !$e->purgedEverything && count($e->urls) > 0;
});
}

#[Test]
public function it_fires_cache_purged_event_after_synchronous_purge_everything()
{
Event::fake();
config([
'cloudflare-cache.queue_purge' => false,
'cloudflare-cache.purge_urls' => false,
'cloudflare-cache.purge_everything_fallback' => true,
]);

$entry = $this->mockEntry();
$event = new EntrySaved($entry);

$clientMock = $this->mock(Client::class);
$clientMock->shouldReceive('purgeEverything')->once();

$listener = $this->app->make(PurgeCloudflareCache::class);
$listener->handle($event);

Event::assertDispatched(CachePurged::class, function ($e) {
return $e->purgedEverything && empty($e->urls);
});
}
}