Skip to content

[5.x] Added the ability for Protectors to allow static caching #11542

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: 5.x
Choose a base branch
from
Open
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
6 changes: 6 additions & 0 deletions src/Auth/Protect/Protection.php
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,12 @@ public function protect()
->protect();
}

public function cacheable()
{
return $this->driver()
->cacheable();
}

protected function url()
{
return URL::tidy(request()->fullUrl());
Expand Down
5 changes: 5 additions & 0 deletions src/Auth/Protect/Protectors/Protector.php
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,9 @@ public function setConfig($config)

return $this;
}

public function cacheable()
{
return false;
}
}
2 changes: 1 addition & 1 deletion src/Http/Responses/DataResponse.php
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ protected function protect()

$protection->protect();

if ($protection->scheme()) {
if ($protection->scheme() && ! $protection->cacheable()) {
$this->headers['X-Statamic-Protected'] = true;
}

Expand Down
40 changes: 40 additions & 0 deletions tests/Auth/Protect/ProtectionTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,46 @@ public function protect()
$this->assertTrue($state->protected);
}

#[Test]
public function protector_driver_allows_static_caching()
{
config(['statamic.protect.default' => 'test']);
config(['statamic.protect.schemes.test' => [
'driver' => 'test',
]]);

app(ProtectorManager::class)->extend('test', function ($app) {
return new class() extends Protector
{
public function protect()
{
//
}

public function cacheable()
{
return true;
}
};
});

$this->assertTrue($this->protection->cacheable());
$this->assertTrue($this->protection->driver()->cacheable());
}

#[Test]
public function protector_driver_disallows_static_caching()
{
config(['statamic.protect.default' => 'logged_in']);
config(['statamic.protect.schemes.logged_in' => [
'driver' => 'auth',
'form_url' => '/login',
]]);

$this->assertFalse($this->protection->cacheable());
$this->assertFalse($this->protection->driver()->cacheable());
}

private function createEntryWithScheme($scheme)
{
return EntryFactory::id('test')
Expand Down
41 changes: 41 additions & 0 deletions tests/FrontendTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
use Illuminate\Support\Facades\Event;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Test;
use Statamic\Auth\Protect\ProtectorManager;
use Statamic\Auth\Protect\Protectors\Protector;
use Statamic\Events\ResponseCreated;
use Statamic\Facades\Blueprint;
use Statamic\Facades\Cascade;
Expand Down Expand Up @@ -373,6 +375,45 @@ public function header_is_added_to_protected_responses()
->assertHeader('X-Statamic-Protected', true);
}

#[Test]
public function header_is_not_added_to_cacheable_protected_responses()
{
// config(['statamic.protect.default' => 'test']);
config(['statamic.protect.schemes.test' => [
'driver' => 'test',
]]);

app(ProtectorManager::class)->extend('test', function ($app) {
return new class() extends Protector
{
public function protect()
{
//
}

public function cacheable()
{
return true;
}
};
});

$page = $this->createPage('about');

$this
->get('/about')
->assertOk()
->assertHeaderMissing('X-Statamic-Protected');

$page->set('protect', 'test')->save();

$this
->actingAs(User::make())
->get('/about')
->assertOk()
->assertHeaderMissing('X-Statamic-Protected');
}

#[Test]
public function key_variables_key_added()
{
Expand Down