Skip to content

[6.x] Fix old slug not removed from static cache when changing slugs#15021

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.

Sign up for GitHub

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
mynetx wants to merge 1 commit into
base:6.x
Choose a base branch
from
+138 −1
Open

[6.x] Fix old slug not removed from static cache when changing slugs #15021

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
34 changes: 33 additions & 1 deletion src/StaticCaching/DefaultInvalidator.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
use Statamic\Contracts\Entries\Entry;
use Statamic\Contracts\Forms\Form;
use Statamic\Contracts\Globals\Variables;
use Statamic\Contracts\Routing\UrlBuilder;
use Statamic\Contracts\Structures\Nav;
use Statamic\Contracts\Structures\NavTree;
use Statamic\Facades\Antlers;
Expand All@@ -32,6 +33,11 @@ public function __construct(Cacher $cacher, $rules = [])

public function invalidate($item)
{
// Old URLs no longer resolve so they cannot be recached, only invalidated.
if ($this->refreshing && ($oldUrls = $this->getItemOldUrls($item))) {
$this->cacher->invalidateUrls($oldUrls);
}

if ($this->rules === 'all') {
$this->refreshing
? $this->cacher->refreshUrls($this->cacher->getUrls()->all())
Expand All@@ -44,7 +50,7 @@ public function invalidate($item)

$this->refreshing
? $this->cacher->refreshUrls($urls)
: $this->cacher->invalidateUrls($urls);
: $this->cacher->invalidateUrls([...$urls, ...$this->getItemOldUrls($item)]);
}

public function refresh($item)
Expand DownExpand Up@@ -92,6 +98,32 @@ protected function getItemUrls($item)
return $urls;
}

protected function getItemOldUrls($item)
{
return $item instanceof Entry ? $this->getOldEntryUrls($item) : [];
}

protected function getOldEntryUrls($entry)
{
if (
is_null($originalSlug = $entry->getOriginal('slug'))
|| $originalSlug === $entry->slug()
|| ! ($route = $entry->route())
) {
return [];
}

$uri = app(UrlBuilder::class)->content($entry)->merge([
'parent_uri' => $entry->parent()?->uri(),
'slug' => $originalSlug,
])->build($route);

$oldUrl = URL::tidy($entry->site()->url().'/'.$uri);

// Anything cached under the old URL (descendants, mounted collections) is stale too.
return [$oldUrl, Str::finish($oldUrl, '/').'*'];
}

protected function getFormUrls($form)
{
$rules = collect(Arr::get($this->rules, "forms.{$form->handle()}.urls"));
Expand Down
105 changes: 105 additions & 0 deletions tests/StaticCaching/DefaultInvalidatorTest.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -314,6 +314,7 @@ public function collection_urls_can_be_invalidated_by_an_entry()
$m->shouldReceive('descendants')->andReturn(collect());
$m->shouldReceive('site')->andReturn(Site::default());
$m->shouldReceive('parent')->andReturnNull();
$m->shouldReceive('getOriginal')->andReturnNull();
$m->shouldReceive('toAugmentedCollection')
->andReturnSelf()
->shouldReceive('merge')
Expand DownExpand Up@@ -368,6 +369,7 @@ public function collection_urls_can_be_invalidated_by_an_entry_in_a_multisite()
$m->shouldReceive('descendants')->andReturn(collect());
$m->shouldReceive('site')->andReturn(Site::get('fr'));
$m->shouldReceive('parent')->andReturnNull();
$m->shouldReceive('getOriginal')->andReturnNull();
$m->shouldReceive('toAugmentedCollection')
->andReturnSelf()
->shouldReceive('merge')
Expand DownExpand Up@@ -417,6 +419,7 @@ public function invalidation_urls_respect_trailing_slash_enforcement()
$m->shouldReceive('descendants')->andReturn(collect());
$m->shouldReceive('site')->andReturn(Site::default());
$m->shouldReceive('parent')->andReturnNull();
$m->shouldReceive('getOriginal')->andReturnNull();
$m->shouldReceive('toAugmentedCollection')
->andReturnSelf()
->shouldReceive('merge')
Expand DownExpand Up@@ -456,6 +459,7 @@ public function entry_urls_are_not_invalidated_by_an_entry_with_a_redirect()
$m->shouldReceive('collectionHandle')->andReturn('blog');
$m->shouldReceive('descendants')->andReturn(collect());
$m->shouldReceive('parent')->andReturnNull();
$m->shouldReceive('getOriginal')->andReturnNull();
$m->shouldReceive('site')->andReturn(Site::default());
$m->shouldReceive('toAugmentedCollection')
->andReturnSelf()
Expand All@@ -479,6 +483,68 @@ public function entry_urls_are_not_invalidated_by_an_entry_with_a_redirect()
$this->assertNull($invalidator->invalidate($entry));
}

#[Test]
public function old_entry_url_is_invalidated_when_the_slug_changes()
{
$cacher = tap(Mockery::mock(Cacher::class), function ($cacher) {
$cacher->shouldReceive('invalidateUrls')->with([
'http://localhost/blog/new-slug',
'http://localhost/blog/old-slug',
'http://localhost/blog/old-slug/*',
])->once();
});

$entry = tap(Mockery::mock(Entry::class), function ($m) {
$m->shouldReceive('isRedirect')->andReturn(false);
$m->shouldReceive('absoluteUrl')->andReturn('http://localhost/blog/new-slug');
$m->shouldReceive('collectionHandle')->andReturn('blog');
$m->shouldReceive('descendants')->andReturn(collect());
$m->shouldReceive('site')->andReturn(Site::default());
$m->shouldReceive('parent')->andReturnNull();
$m->shouldReceive('getOriginal')->with('slug')->andReturn('old-slug');
$m->shouldReceive('slug')->andReturn('new-slug');
$m->shouldReceive('route')->andReturn('/blog/{slug}');
$m->shouldReceive('routeData')->andReturn(['slug' => 'new-slug']);
$m->shouldReceive('toAugmentedCollection')
->andReturnSelf()
->shouldReceive('merge')
->andReturn(collect(['parent_uri' => null]));
});

$invalidator = new Invalidator($cacher, []);

$this->assertNull($invalidator->invalidate($entry));
}

#[Test]
public function old_entry_url_is_not_invalidated_when_the_slug_is_unchanged()
{
$cacher = tap(Mockery::mock(Cacher::class), function ($cacher) {
$cacher->shouldReceive('invalidateUrls')->with([
'http://localhost/blog/my-slug',
])->once();
});

$entry = tap(Mockery::mock(Entry::class), function ($m) {
$m->shouldReceive('isRedirect')->andReturn(false);
$m->shouldReceive('absoluteUrl')->andReturn('http://localhost/blog/my-slug');
$m->shouldReceive('collectionHandle')->andReturn('blog');
$m->shouldReceive('descendants')->andReturn(collect());
$m->shouldReceive('site')->andReturn(Site::default());
$m->shouldReceive('parent')->andReturnNull();
$m->shouldReceive('getOriginal')->with('slug')->andReturn('my-slug');
$m->shouldReceive('slug')->andReturn('my-slug');
$m->shouldReceive('toAugmentedCollection')
->andReturnSelf()
->shouldReceive('merge')
->andReturn(collect(['parent_uri' => null]));
});

$invalidator = new Invalidator($cacher, []);

$this->assertNull($invalidator->invalidate($entry));
}

#[Test]
public function taxonomy_urls_can_be_invalidated()
{
Expand DownExpand Up@@ -961,6 +1027,7 @@ public function it_doesnt_recache_when_background_recache_token_is_disabled()
$m->shouldReceive('descendants')->andReturn(collect());
$m->shouldReceive('site')->andReturn(Site::default());
$m->shouldReceive('parent')->andReturnNull();
$m->shouldReceive('getOriginal')->andReturnNull();
$m->shouldReceive('toAugmentedCollection')
->andReturnSelf()
->shouldReceive('merge')
Expand DownExpand Up@@ -1001,6 +1068,7 @@ public function it_recaches_when_background_recache_token_is_enabled()
$m->shouldReceive('descendants')->andReturn(collect());
$m->shouldReceive('site')->andReturn(Site::default());
$m->shouldReceive('parent')->andReturnNull();
$m->shouldReceive('getOriginal')->andReturnNull();
$m->shouldReceive('toAugmentedCollection')
->andReturnSelf()
->shouldReceive('merge')
Expand All@@ -1021,6 +1089,43 @@ public function it_recaches_when_background_recache_token_is_enabled()
$this->assertNull($invalidator->refresh($entry));
}

#[Test]
public function old_entry_url_is_invalidated_rather_than_recached_when_background_recache_is_enabled()
{
config()->set('statamic.static_caching.background_recache', true);

$cacher = tap(Mockery::mock(Cacher::class), function ($cacher) {
$cacher->shouldReceive('invalidateUrls')->once()->with([
'http://localhost/blog/old-slug',
'http://localhost/blog/old-slug/*',
]);
$cacher->shouldReceive('refreshUrls')->once()->with([
'http://localhost/blog/new-slug',
]);
});

$entry = tap(Mockery::mock(Entry::class), function ($m) {
$m->shouldReceive('isRedirect')->andReturn(false);
$m->shouldReceive('absoluteUrl')->andReturn('http://localhost/blog/new-slug');
$m->shouldReceive('collectionHandle')->andReturn('blog');
$m->shouldReceive('descendants')->andReturn(collect());
$m->shouldReceive('site')->andReturn(Site::default());
$m->shouldReceive('parent')->andReturnNull();
$m->shouldReceive('getOriginal')->with('slug')->andReturn('old-slug');
$m->shouldReceive('slug')->andReturn('new-slug');
$m->shouldReceive('route')->andReturn('/blog/{slug}');
$m->shouldReceive('routeData')->andReturn(['slug' => 'new-slug']);
$m->shouldReceive('toAugmentedCollection')
->andReturnSelf()
->shouldReceive('merge')
->andReturn(collect(['parent_uri' => null]));
});

$invalidator = new Invalidator($cacher, []);

$this->assertNull($invalidator->refresh($entry));
}

#[Test]
public function it_calls_the_custom_invalidate_method_when_background_recache_is_enabled()
{
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
[6.x] Fix old slug not removed from static cache when changing slugs by mynetx · Pull Request #15021 · statamic/cms · GitHub
Skip to content
[6.x] Fix old slug not removed from static cache when changing slugs#15021

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.

 Sign up for GitHub

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

mynetx
wants to merge
1
commit into

base:6.x
Choose a base branch

from


+138

−1

 Open


[6.x] Fix old slug not removed from static cache when changing slugs
#15021
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


34 changes: 33 additions & 1 deletion
src/StaticCaching/DefaultInvalidator.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
use Statamic\Contracts\Entries\Entry;
use Statamic\Contracts\Forms\Form;
use Statamic\Contracts\Globals\Variables;
use Statamic\Contracts\Routing\UrlBuilder;
use Statamic\Contracts\Structures\Nav;
use Statamic\Contracts\Structures\NavTree;
use Statamic\Facades\Antlers;
Expand All@@ -32,6 +33,11 @@ public function __construct(Cacher $cacher, $rules = [])

 public function invalidate($item)
 {
 // Old URLs no longer resolve so they cannot be recached, only invalidated.
 if ($this->refreshing && ($oldUrls = $this->getItemOldUrls($item))) {
 $this->cacher->invalidateUrls($oldUrls);
 }

 if ($this->rules === 'all') {
 $this->refreshing
 ? $this->cacher->refreshUrls($this->cacher->getUrls()->all())
Expand All@@ -44,7 +50,7 @@ public function invalidate($item)

 $this->refreshing
 ? $this->cacher->refreshUrls($urls)
 : $this->cacher->invalidateUrls($urls);
 : $this->cacher->invalidateUrls([...$urls, ...$this->getItemOldUrls($item)]);
 }

 public function refresh($item)
Expand DownExpand Up@@ -92,6 +98,32 @@ protected function getItemUrls($item)
 return $urls;
 }

 protected function getItemOldUrls($item)
 {
 return $item instanceof Entry ? $this->getOldEntryUrls($item) : [];
 }

 protected function getOldEntryUrls($entry)
 {
 if (
 is_null($originalSlug = $entry->getOriginal('slug'))
 || $originalSlug === $entry->slug()
 || ! ($route = $entry->route())
 ) {
 return [];
 }

 $uri = app(UrlBuilder::class)->content($entry)->merge([
 'parent_uri' => $entry->parent()?->uri(),
 'slug' => $originalSlug,
 ])->build($route);

 $oldUrl = URL::tidy($entry->site()->url().'/'.$uri);

 // Anything cached under the old URL (descendants, mounted collections) is stale too.
 return [$oldUrl, Str::finish($oldUrl, '/').'*'];
 }

 protected function getFormUrls($form)
 {
 $rules = collect(Arr::get($this->rules, "forms.{$form->handle()}.urls"));
Expand Down

105 changes: 105 additions & 0 deletions
tests/StaticCaching/DefaultInvalidatorTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -314,6 +314,7 @@ public function collection_urls_can_be_invalidated_by_an_entry()
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->andReturnNull();
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
Expand DownExpand Up@@ -368,6 +369,7 @@ public function collection_urls_can_be_invalidated_by_an_entry_in_a_multisite()
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::get('fr'));
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->andReturnNull();
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
Expand DownExpand Up@@ -417,6 +419,7 @@ public function invalidation_urls_respect_trailing_slash_enforcement()
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->andReturnNull();
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
Expand DownExpand Up@@ -456,6 +459,7 @@ public function entry_urls_are_not_invalidated_by_an_entry_with_a_redirect()
 $m->shouldReceive('collectionHandle')->andReturn('blog');
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->andReturnNull();
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
Expand All@@ -479,6 +483,68 @@ public function entry_urls_are_not_invalidated_by_an_entry_with_a_redirect()
 $this->assertNull($invalidator->invalidate($entry));
 }

 #[Test]
 public function old_entry_url_is_invalidated_when_the_slug_changes()
 {
 $cacher = tap(Mockery::mock(Cacher::class), function ($cacher) {
 $cacher->shouldReceive('invalidateUrls')->with([
 'http://localhost/blog/new-slug',
 'http://localhost/blog/old-slug',
 'http://localhost/blog/old-slug/*',
 ])->once();
 });

 $entry = tap(Mockery::mock(Entry::class), function ($m) {
 $m->shouldReceive('isRedirect')->andReturn(false);
 $m->shouldReceive('absoluteUrl')->andReturn('http://localhost/blog/new-slug');
 $m->shouldReceive('collectionHandle')->andReturn('blog');
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->with('slug')->andReturn('old-slug');
 $m->shouldReceive('slug')->andReturn('new-slug');
 $m->shouldReceive('route')->andReturn('/blog/{slug}');
 $m->shouldReceive('routeData')->andReturn(['slug' => 'new-slug']);
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
 ->andReturn(collect(['parent_uri' => null]));
 });

 $invalidator = new Invalidator($cacher, []);

 $this->assertNull($invalidator->invalidate($entry));
 }

 #[Test]
 public function old_entry_url_is_not_invalidated_when_the_slug_is_unchanged()
 {
 $cacher = tap(Mockery::mock(Cacher::class), function ($cacher) {
 $cacher->shouldReceive('invalidateUrls')->with([
 'http://localhost/blog/my-slug',
 ])->once();
 });

 $entry = tap(Mockery::mock(Entry::class), function ($m) {
 $m->shouldReceive('isRedirect')->andReturn(false);
 $m->shouldReceive('absoluteUrl')->andReturn('http://localhost/blog/my-slug');
 $m->shouldReceive('collectionHandle')->andReturn('blog');
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->with('slug')->andReturn('my-slug');
 $m->shouldReceive('slug')->andReturn('my-slug');
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
 ->andReturn(collect(['parent_uri' => null]));
 });

 $invalidator = new Invalidator($cacher, []);

 $this->assertNull($invalidator->invalidate($entry));
 }

 #[Test]
 public function taxonomy_urls_can_be_invalidated()
 {
Expand DownExpand Up@@ -961,6 +1027,7 @@ public function it_doesnt_recache_when_background_recache_token_is_disabled()
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->andReturnNull();
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
Expand DownExpand Up@@ -1001,6 +1068,7 @@ public function it_recaches_when_background_recache_token_is_enabled()
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->andReturnNull();
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
Expand All@@ -1021,6 +1089,43 @@ public function it_recaches_when_background_recache_token_is_enabled()
 $this->assertNull($invalidator->refresh($entry));
 }

 #[Test]
 public function old_entry_url_is_invalidated_rather_than_recached_when_background_recache_is_enabled()
 {
 config()->set('statamic.static_caching.background_recache', true);

 $cacher = tap(Mockery::mock(Cacher::class), function ($cacher) {
 $cacher->shouldReceive('invalidateUrls')->once()->with([
 'http://localhost/blog/old-slug',
 'http://localhost/blog/old-slug/*',
 ]);
 $cacher->shouldReceive('refreshUrls')->once()->with([
 'http://localhost/blog/new-slug',
 ]);
 });

 $entry = tap(Mockery::mock(Entry::class), function ($m) {
 $m->shouldReceive('isRedirect')->andReturn(false);
 $m->shouldReceive('absoluteUrl')->andReturn('http://localhost/blog/new-slug');
 $m->shouldReceive('collectionHandle')->andReturn('blog');
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->with('slug')->andReturn('old-slug');
 $m->shouldReceive('slug')->andReturn('new-slug');
 $m->shouldReceive('route')->andReturn('/blog/{slug}');
 $m->shouldReceive('routeData')->andReturn(['slug' => 'new-slug']);
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
 ->andReturn(collect(['parent_uri' => null]));
 });

 $invalidator = new Invalidator($cacher, []);

 $this->assertNull($invalidator->refresh($entry));
 }

 #[Test]
 public function it_calls_the_custom_invalidate_method_when_background_recache_is_enabled()
 {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[6.x] Fix old slug not removed from static cache when changing slugs by mynetx · Pull Request #15021 · statamic/cms · GitHub
Skip to content
[6.x] Fix old slug not removed from static cache when changing slugs#15021

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.

 Sign up for GitHub

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

mynetx
wants to merge
1
commit into

base:6.x
Choose a base branch

from


+138

−1

 Open


[6.x] Fix old slug not removed from static cache when changing slugs
#15021
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


34 changes: 33 additions & 1 deletion
src/StaticCaching/DefaultInvalidator.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
use Statamic\Contracts\Entries\Entry;
use Statamic\Contracts\Forms\Form;
use Statamic\Contracts\Globals\Variables;
use Statamic\Contracts\Routing\UrlBuilder;
use Statamic\Contracts\Structures\Nav;
use Statamic\Contracts\Structures\NavTree;
use Statamic\Facades\Antlers;
Expand All@@ -32,6 +33,11 @@ public function __construct(Cacher $cacher, $rules = [])

 public function invalidate($item)
 {
 // Old URLs no longer resolve so they cannot be recached, only invalidated.
 if ($this->refreshing && ($oldUrls = $this->getItemOldUrls($item))) {
 $this->cacher->invalidateUrls($oldUrls);
 }

 if ($this->rules === 'all') {
 $this->refreshing
 ? $this->cacher->refreshUrls($this->cacher->getUrls()->all())
Expand All@@ -44,7 +50,7 @@ public function invalidate($item)

 $this->refreshing
 ? $this->cacher->refreshUrls($urls)
 : $this->cacher->invalidateUrls($urls);
 : $this->cacher->invalidateUrls([...$urls, ...$this->getItemOldUrls($item)]);
 }

 public function refresh($item)
Expand DownExpand Up@@ -92,6 +98,32 @@ protected function getItemUrls($item)
 return $urls;
 }

 protected function getItemOldUrls($item)
 {
 return $item instanceof Entry ? $this->getOldEntryUrls($item) : [];
 }

 protected function getOldEntryUrls($entry)
 {
 if (
 is_null($originalSlug = $entry->getOriginal('slug'))
 || $originalSlug === $entry->slug()
 || ! ($route = $entry->route())
 ) {
 return [];
 }

 $uri = app(UrlBuilder::class)->content($entry)->merge([
 'parent_uri' => $entry->parent()?->uri(),
 'slug' => $originalSlug,
 ])->build($route);

 $oldUrl = URL::tidy($entry->site()->url().'/'.$uri);

 // Anything cached under the old URL (descendants, mounted collections) is stale too.
 return [$oldUrl, Str::finish($oldUrl, '/').'*'];
 }

 protected function getFormUrls($form)
 {
 $rules = collect(Arr::get($this->rules, "forms.{$form->handle()}.urls"));
Expand Down

105 changes: 105 additions & 0 deletions
tests/StaticCaching/DefaultInvalidatorTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -314,6 +314,7 @@ public function collection_urls_can_be_invalidated_by_an_entry()
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->andReturnNull();
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
Expand DownExpand Up@@ -368,6 +369,7 @@ public function collection_urls_can_be_invalidated_by_an_entry_in_a_multisite()
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::get('fr'));
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->andReturnNull();
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
Expand DownExpand Up@@ -417,6 +419,7 @@ public function invalidation_urls_respect_trailing_slash_enforcement()
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->andReturnNull();
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
Expand DownExpand Up@@ -456,6 +459,7 @@ public function entry_urls_are_not_invalidated_by_an_entry_with_a_redirect()
 $m->shouldReceive('collectionHandle')->andReturn('blog');
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->andReturnNull();
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
Expand All@@ -479,6 +483,68 @@ public function entry_urls_are_not_invalidated_by_an_entry_with_a_redirect()
 $this->assertNull($invalidator->invalidate($entry));
 }

 #[Test]
 public function old_entry_url_is_invalidated_when_the_slug_changes()
 {
 $cacher = tap(Mockery::mock(Cacher::class), function ($cacher) {
 $cacher->shouldReceive('invalidateUrls')->with([
 'http://localhost/blog/new-slug',
 'http://localhost/blog/old-slug',
 'http://localhost/blog/old-slug/*',
 ])->once();
 });

 $entry = tap(Mockery::mock(Entry::class), function ($m) {
 $m->shouldReceive('isRedirect')->andReturn(false);
 $m->shouldReceive('absoluteUrl')->andReturn('http://localhost/blog/new-slug');
 $m->shouldReceive('collectionHandle')->andReturn('blog');
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->with('slug')->andReturn('old-slug');
 $m->shouldReceive('slug')->andReturn('new-slug');
 $m->shouldReceive('route')->andReturn('/blog/{slug}');
 $m->shouldReceive('routeData')->andReturn(['slug' => 'new-slug']);
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
 ->andReturn(collect(['parent_uri' => null]));
 });

 $invalidator = new Invalidator($cacher, []);

 $this->assertNull($invalidator->invalidate($entry));
 }

 #[Test]
 public function old_entry_url_is_not_invalidated_when_the_slug_is_unchanged()
 {
 $cacher = tap(Mockery::mock(Cacher::class), function ($cacher) {
 $cacher->shouldReceive('invalidateUrls')->with([
 'http://localhost/blog/my-slug',
 ])->once();
 });

 $entry = tap(Mockery::mock(Entry::class), function ($m) {
 $m->shouldReceive('isRedirect')->andReturn(false);
 $m->shouldReceive('absoluteUrl')->andReturn('http://localhost/blog/my-slug');
 $m->shouldReceive('collectionHandle')->andReturn('blog');
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->with('slug')->andReturn('my-slug');
 $m->shouldReceive('slug')->andReturn('my-slug');
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
 ->andReturn(collect(['parent_uri' => null]));
 });

 $invalidator = new Invalidator($cacher, []);

 $this->assertNull($invalidator->invalidate($entry));
 }

 #[Test]
 public function taxonomy_urls_can_be_invalidated()
 {
Expand DownExpand Up@@ -961,6 +1027,7 @@ public function it_doesnt_recache_when_background_recache_token_is_disabled()
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->andReturnNull();
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
Expand DownExpand Up@@ -1001,6 +1068,7 @@ public function it_recaches_when_background_recache_token_is_enabled()
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->andReturnNull();
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
Expand All@@ -1021,6 +1089,43 @@ public function it_recaches_when_background_recache_token_is_enabled()
 $this->assertNull($invalidator->refresh($entry));
 }

 #[Test]
 public function old_entry_url_is_invalidated_rather_than_recached_when_background_recache_is_enabled()
 {
 config()->set('statamic.static_caching.background_recache', true);

 $cacher = tap(Mockery::mock(Cacher::class), function ($cacher) {
 $cacher->shouldReceive('invalidateUrls')->once()->with([
 'http://localhost/blog/old-slug',
 'http://localhost/blog/old-slug/*',
 ]);
 $cacher->shouldReceive('refreshUrls')->once()->with([
 'http://localhost/blog/new-slug',
 ]);
 });

 $entry = tap(Mockery::mock(Entry::class), function ($m) {
 $m->shouldReceive('isRedirect')->andReturn(false);
 $m->shouldReceive('absoluteUrl')->andReturn('http://localhost/blog/new-slug');
 $m->shouldReceive('collectionHandle')->andReturn('blog');
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->with('slug')->andReturn('old-slug');
 $m->shouldReceive('slug')->andReturn('new-slug');
 $m->shouldReceive('route')->andReturn('/blog/{slug}');
 $m->shouldReceive('routeData')->andReturn(['slug' => 'new-slug']);
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
 ->andReturn(collect(['parent_uri' => null]));
 });

 $invalidator = new Invalidator($cacher, []);

 $this->assertNull($invalidator->refresh($entry));
 }

 #[Test]
 public function it_calls_the_custom_invalidate_method_when_background_recache_is_enabled()
 {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[6.x] Fix old slug not removed from static cache when changing slugs by mynetx · Pull Request #15021 · statamic/cms · GitHub
Skip to content
[6.x] Fix old slug not removed from static cache when changing slugs#15021

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.

 Sign up for GitHub

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

mynetx
wants to merge
1
commit into

base:6.x
Choose a base branch

from


+138

−1

 Open


[6.x] Fix old slug not removed from static cache when changing slugs
#15021
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


34 changes: 33 additions & 1 deletion
src/StaticCaching/DefaultInvalidator.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
use Statamic\Contracts\Entries\Entry;
use Statamic\Contracts\Forms\Form;
use Statamic\Contracts\Globals\Variables;
use Statamic\Contracts\Routing\UrlBuilder;
use Statamic\Contracts\Structures\Nav;
use Statamic\Contracts\Structures\NavTree;
use Statamic\Facades\Antlers;
Expand All@@ -32,6 +33,11 @@ public function __construct(Cacher $cacher, $rules = [])

 public function invalidate($item)
 {
 // Old URLs no longer resolve so they cannot be recached, only invalidated.
 if ($this->refreshing && ($oldUrls = $this->getItemOldUrls($item))) {
 $this->cacher->invalidateUrls($oldUrls);
 }

 if ($this->rules === 'all') {
 $this->refreshing
 ? $this->cacher->refreshUrls($this->cacher->getUrls()->all())
Expand All@@ -44,7 +50,7 @@ public function invalidate($item)

 $this->refreshing
 ? $this->cacher->refreshUrls($urls)
 : $this->cacher->invalidateUrls($urls);
 : $this->cacher->invalidateUrls([...$urls, ...$this->getItemOldUrls($item)]);
 }

 public function refresh($item)
Expand DownExpand Up@@ -92,6 +98,32 @@ protected function getItemUrls($item)
 return $urls;
 }

 protected function getItemOldUrls($item)
 {
 return $item instanceof Entry ? $this->getOldEntryUrls($item) : [];
 }

 protected function getOldEntryUrls($entry)
 {
 if (
 is_null($originalSlug = $entry->getOriginal('slug'))
 || $originalSlug === $entry->slug()
 || ! ($route = $entry->route())
 ) {
 return [];
 }

 $uri = app(UrlBuilder::class)->content($entry)->merge([
 'parent_uri' => $entry->parent()?->uri(),
 'slug' => $originalSlug,
 ])->build($route);

 $oldUrl = URL::tidy($entry->site()->url().'/'.$uri);

 // Anything cached under the old URL (descendants, mounted collections) is stale too.
 return [$oldUrl, Str::finish($oldUrl, '/').'*'];
 }

 protected function getFormUrls($form)
 {
 $rules = collect(Arr::get($this->rules, "forms.{$form->handle()}.urls"));
Expand Down

105 changes: 105 additions & 0 deletions
tests/StaticCaching/DefaultInvalidatorTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -314,6 +314,7 @@ public function collection_urls_can_be_invalidated_by_an_entry()
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->andReturnNull();
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
Expand DownExpand Up@@ -368,6 +369,7 @@ public function collection_urls_can_be_invalidated_by_an_entry_in_a_multisite()
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::get('fr'));
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->andReturnNull();
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
Expand DownExpand Up@@ -417,6 +419,7 @@ public function invalidation_urls_respect_trailing_slash_enforcement()
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->andReturnNull();
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
Expand DownExpand Up@@ -456,6 +459,7 @@ public function entry_urls_are_not_invalidated_by_an_entry_with_a_redirect()
 $m->shouldReceive('collectionHandle')->andReturn('blog');
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->andReturnNull();
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
Expand All@@ -479,6 +483,68 @@ public function entry_urls_are_not_invalidated_by_an_entry_with_a_redirect()
 $this->assertNull($invalidator->invalidate($entry));
 }

 #[Test]
 public function old_entry_url_is_invalidated_when_the_slug_changes()
 {
 $cacher = tap(Mockery::mock(Cacher::class), function ($cacher) {
 $cacher->shouldReceive('invalidateUrls')->with([
 'http://localhost/blog/new-slug',
 'http://localhost/blog/old-slug',
 'http://localhost/blog/old-slug/*',
 ])->once();
 });

 $entry = tap(Mockery::mock(Entry::class), function ($m) {
 $m->shouldReceive('isRedirect')->andReturn(false);
 $m->shouldReceive('absoluteUrl')->andReturn('http://localhost/blog/new-slug');
 $m->shouldReceive('collectionHandle')->andReturn('blog');
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->with('slug')->andReturn('old-slug');
 $m->shouldReceive('slug')->andReturn('new-slug');
 $m->shouldReceive('route')->andReturn('/blog/{slug}');
 $m->shouldReceive('routeData')->andReturn(['slug' => 'new-slug']);
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
 ->andReturn(collect(['parent_uri' => null]));
 });

 $invalidator = new Invalidator($cacher, []);

 $this->assertNull($invalidator->invalidate($entry));
 }

 #[Test]
 public function old_entry_url_is_not_invalidated_when_the_slug_is_unchanged()
 {
 $cacher = tap(Mockery::mock(Cacher::class), function ($cacher) {
 $cacher->shouldReceive('invalidateUrls')->with([
 'http://localhost/blog/my-slug',
 ])->once();
 });

 $entry = tap(Mockery::mock(Entry::class), function ($m) {
 $m->shouldReceive('isRedirect')->andReturn(false);
 $m->shouldReceive('absoluteUrl')->andReturn('http://localhost/blog/my-slug');
 $m->shouldReceive('collectionHandle')->andReturn('blog');
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->with('slug')->andReturn('my-slug');
 $m->shouldReceive('slug')->andReturn('my-slug');
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
 ->andReturn(collect(['parent_uri' => null]));
 });

 $invalidator = new Invalidator($cacher, []);

 $this->assertNull($invalidator->invalidate($entry));
 }

 #[Test]
 public function taxonomy_urls_can_be_invalidated()
 {
Expand DownExpand Up@@ -961,6 +1027,7 @@ public function it_doesnt_recache_when_background_recache_token_is_disabled()
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->andReturnNull();
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
Expand DownExpand Up@@ -1001,6 +1068,7 @@ public function it_recaches_when_background_recache_token_is_enabled()
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->andReturnNull();
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
Expand All@@ -1021,6 +1089,43 @@ public function it_recaches_when_background_recache_token_is_enabled()
 $this->assertNull($invalidator->refresh($entry));
 }

 #[Test]
 public function old_entry_url_is_invalidated_rather_than_recached_when_background_recache_is_enabled()
 {
 config()->set('statamic.static_caching.background_recache', true);

 $cacher = tap(Mockery::mock(Cacher::class), function ($cacher) {
 $cacher->shouldReceive('invalidateUrls')->once()->with([
 'http://localhost/blog/old-slug',
 'http://localhost/blog/old-slug/*',
 ]);
 $cacher->shouldReceive('refreshUrls')->once()->with([
 'http://localhost/blog/new-slug',
 ]);
 });

 $entry = tap(Mockery::mock(Entry::class), function ($m) {
 $m->shouldReceive('isRedirect')->andReturn(false);
 $m->shouldReceive('absoluteUrl')->andReturn('http://localhost/blog/new-slug');
 $m->shouldReceive('collectionHandle')->andReturn('blog');
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->with('slug')->andReturn('old-slug');
 $m->shouldReceive('slug')->andReturn('new-slug');
 $m->shouldReceive('route')->andReturn('/blog/{slug}');
 $m->shouldReceive('routeData')->andReturn(['slug' => 'new-slug']);
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
 ->andReturn(collect(['parent_uri' => null]));
 });

 $invalidator = new Invalidator($cacher, []);

 $this->assertNull($invalidator->refresh($entry));
 }

 #[Test]
 public function it_calls_the_custom_invalidate_method_when_background_recache_is_enabled()
 {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
[6.x] Fix old slug not removed from static cache when changing slugs by mynetx · Pull Request #15021 · statamic/cms · GitHub
Skip to content
[6.x] Fix old slug not removed from static cache when changing slugs#15021

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.

 Sign up for GitHub

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

mynetx
wants to merge
1
commit into

base:6.x
Choose a base branch

from


+138

−1

 Open


[6.x] Fix old slug not removed from static cache when changing slugs
#15021
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


34 changes: 33 additions & 1 deletion
src/StaticCaching/DefaultInvalidator.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
use Statamic\Contracts\Entries\Entry;
use Statamic\Contracts\Forms\Form;
use Statamic\Contracts\Globals\Variables;
use Statamic\Contracts\Routing\UrlBuilder;
use Statamic\Contracts\Structures\Nav;
use Statamic\Contracts\Structures\NavTree;
use Statamic\Facades\Antlers;
Expand All@@ -32,6 +33,11 @@ public function __construct(Cacher $cacher, $rules = [])

 public function invalidate($item)
 {
 // Old URLs no longer resolve so they cannot be recached, only invalidated.
 if ($this->refreshing && ($oldUrls = $this->getItemOldUrls($item))) {
 $this->cacher->invalidateUrls($oldUrls);
 }

 if ($this->rules === 'all') {
 $this->refreshing
 ? $this->cacher->refreshUrls($this->cacher->getUrls()->all())
Expand All@@ -44,7 +50,7 @@ public function invalidate($item)

 $this->refreshing
 ? $this->cacher->refreshUrls($urls)
 : $this->cacher->invalidateUrls($urls);
 : $this->cacher->invalidateUrls([...$urls, ...$this->getItemOldUrls($item)]);
 }

 public function refresh($item)
Expand DownExpand Up@@ -92,6 +98,32 @@ protected function getItemUrls($item)
 return $urls;
 }

 protected function getItemOldUrls($item)
 {
 return $item instanceof Entry ? $this->getOldEntryUrls($item) : [];
 }

 protected function getOldEntryUrls($entry)
 {
 if (
 is_null($originalSlug = $entry->getOriginal('slug'))
 || $originalSlug === $entry->slug()
 || ! ($route = $entry->route())
 ) {
 return [];
 }

 $uri = app(UrlBuilder::class)->content($entry)->merge([
 'parent_uri' => $entry->parent()?->uri(),
 'slug' => $originalSlug,
 ])->build($route);

 $oldUrl = URL::tidy($entry->site()->url().'/'.$uri);

 // Anything cached under the old URL (descendants, mounted collections) is stale too.
 return [$oldUrl, Str::finish($oldUrl, '/').'*'];
 }

 protected function getFormUrls($form)
 {
 $rules = collect(Arr::get($this->rules, "forms.{$form->handle()}.urls"));
Expand Down

105 changes: 105 additions & 0 deletions
tests/StaticCaching/DefaultInvalidatorTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -314,6 +314,7 @@ public function collection_urls_can_be_invalidated_by_an_entry()
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->andReturnNull();
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
Expand DownExpand Up@@ -368,6 +369,7 @@ public function collection_urls_can_be_invalidated_by_an_entry_in_a_multisite()
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::get('fr'));
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->andReturnNull();
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
Expand DownExpand Up@@ -417,6 +419,7 @@ public function invalidation_urls_respect_trailing_slash_enforcement()
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->andReturnNull();
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
Expand DownExpand Up@@ -456,6 +459,7 @@ public function entry_urls_are_not_invalidated_by_an_entry_with_a_redirect()
 $m->shouldReceive('collectionHandle')->andReturn('blog');
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->andReturnNull();
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
Expand All@@ -479,6 +483,68 @@ public function entry_urls_are_not_invalidated_by_an_entry_with_a_redirect()
 $this->assertNull($invalidator->invalidate($entry));
 }

 #[Test]
 public function old_entry_url_is_invalidated_when_the_slug_changes()
 {
 $cacher = tap(Mockery::mock(Cacher::class), function ($cacher) {
 $cacher->shouldReceive('invalidateUrls')->with([
 'http://localhost/blog/new-slug',
 'http://localhost/blog/old-slug',
 'http://localhost/blog/old-slug/*',
 ])->once();
 });

 $entry = tap(Mockery::mock(Entry::class), function ($m) {
 $m->shouldReceive('isRedirect')->andReturn(false);
 $m->shouldReceive('absoluteUrl')->andReturn('http://localhost/blog/new-slug');
 $m->shouldReceive('collectionHandle')->andReturn('blog');
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->with('slug')->andReturn('old-slug');
 $m->shouldReceive('slug')->andReturn('new-slug');
 $m->shouldReceive('route')->andReturn('/blog/{slug}');
 $m->shouldReceive('routeData')->andReturn(['slug' => 'new-slug']);
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
 ->andReturn(collect(['parent_uri' => null]));
 });

 $invalidator = new Invalidator($cacher, []);

 $this->assertNull($invalidator->invalidate($entry));
 }

 #[Test]
 public function old_entry_url_is_not_invalidated_when_the_slug_is_unchanged()
 {
 $cacher = tap(Mockery::mock(Cacher::class), function ($cacher) {
 $cacher->shouldReceive('invalidateUrls')->with([
 'http://localhost/blog/my-slug',
 ])->once();
 });

 $entry = tap(Mockery::mock(Entry::class), function ($m) {
 $m->shouldReceive('isRedirect')->andReturn(false);
 $m->shouldReceive('absoluteUrl')->andReturn('http://localhost/blog/my-slug');
 $m->shouldReceive('collectionHandle')->andReturn('blog');
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->with('slug')->andReturn('my-slug');
 $m->shouldReceive('slug')->andReturn('my-slug');
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
 ->andReturn(collect(['parent_uri' => null]));
 });

 $invalidator = new Invalidator($cacher, []);

 $this->assertNull($invalidator->invalidate($entry));
 }

 #[Test]
 public function taxonomy_urls_can_be_invalidated()
 {
Expand DownExpand Up@@ -961,6 +1027,7 @@ public function it_doesnt_recache_when_background_recache_token_is_disabled()
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->andReturnNull();
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
Expand DownExpand Up@@ -1001,6 +1068,7 @@ public function it_recaches_when_background_recache_token_is_enabled()
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->andReturnNull();
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
Expand All@@ -1021,6 +1089,43 @@ public function it_recaches_when_background_recache_token_is_enabled()
 $this->assertNull($invalidator->refresh($entry));
 }

 #[Test]
 public function old_entry_url_is_invalidated_rather_than_recached_when_background_recache_is_enabled()
 {
 config()->set('statamic.static_caching.background_recache', true);

 $cacher = tap(Mockery::mock(Cacher::class), function ($cacher) {
 $cacher->shouldReceive('invalidateUrls')->once()->with([
 'http://localhost/blog/old-slug',
 'http://localhost/blog/old-slug/*',
 ]);
 $cacher->shouldReceive('refreshUrls')->once()->with([
 'http://localhost/blog/new-slug',
 ]);
 });

 $entry = tap(Mockery::mock(Entry::class), function ($m) {
 $m->shouldReceive('isRedirect')->andReturn(false);
 $m->shouldReceive('absoluteUrl')->andReturn('http://localhost/blog/new-slug');
 $m->shouldReceive('collectionHandle')->andReturn('blog');
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->with('slug')->andReturn('old-slug');
 $m->shouldReceive('slug')->andReturn('new-slug');
 $m->shouldReceive('route')->andReturn('/blog/{slug}');
 $m->shouldReceive('routeData')->andReturn(['slug' => 'new-slug']);
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
 ->andReturn(collect(['parent_uri' => null]));
 });

 $invalidator = new Invalidator($cacher, []);

 $this->assertNull($invalidator->refresh($entry));
 }

 #[Test]
 public function it_calls_the_custom_invalidate_method_when_background_recache_is_enabled()
 {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[6.x] Fix old slug not removed from static cache when changing slugs by mynetx · Pull Request #15021 · statamic/cms · GitHub
Skip to content
[6.x] Fix old slug not removed from static cache when changing slugs#15021

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.

 Sign up for GitHub

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

mynetx
wants to merge
1
commit into

base:6.x
Choose a base branch

from


+138

−1

 Open


[6.x] Fix old slug not removed from static cache when changing slugs
#15021
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


34 changes: 33 additions & 1 deletion
src/StaticCaching/DefaultInvalidator.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
use Statamic\Contracts\Entries\Entry;
use Statamic\Contracts\Forms\Form;
use Statamic\Contracts\Globals\Variables;
use Statamic\Contracts\Routing\UrlBuilder;
use Statamic\Contracts\Structures\Nav;
use Statamic\Contracts\Structures\NavTree;
use Statamic\Facades\Antlers;
Expand All@@ -32,6 +33,11 @@ public function __construct(Cacher $cacher, $rules = [])

 public function invalidate($item)
 {
 // Old URLs no longer resolve so they cannot be recached, only invalidated.
 if ($this->refreshing && ($oldUrls = $this->getItemOldUrls($item))) {
 $this->cacher->invalidateUrls($oldUrls);
 }

 if ($this->rules === 'all') {
 $this->refreshing
 ? $this->cacher->refreshUrls($this->cacher->getUrls()->all())
Expand All@@ -44,7 +50,7 @@ public function invalidate($item)

 $this->refreshing
 ? $this->cacher->refreshUrls($urls)
 : $this->cacher->invalidateUrls($urls);
 : $this->cacher->invalidateUrls([...$urls, ...$this->getItemOldUrls($item)]);
 }

 public function refresh($item)
Expand DownExpand Up@@ -92,6 +98,32 @@ protected function getItemUrls($item)
 return $urls;
 }

 protected function getItemOldUrls($item)
 {
 return $item instanceof Entry ? $this->getOldEntryUrls($item) : [];
 }

 protected function getOldEntryUrls($entry)
 {
 if (
 is_null($originalSlug = $entry->getOriginal('slug'))
 || $originalSlug === $entry->slug()
 || ! ($route = $entry->route())
 ) {
 return [];
 }

 $uri = app(UrlBuilder::class)->content($entry)->merge([
 'parent_uri' => $entry->parent()?->uri(),
 'slug' => $originalSlug,
 ])->build($route);

 $oldUrl = URL::tidy($entry->site()->url().'/'.$uri);

 // Anything cached under the old URL (descendants, mounted collections) is stale too.
 return [$oldUrl, Str::finish($oldUrl, '/').'*'];
 }

 protected function getFormUrls($form)
 {
 $rules = collect(Arr::get($this->rules, "forms.{$form->handle()}.urls"));
Expand Down

105 changes: 105 additions & 0 deletions
tests/StaticCaching/DefaultInvalidatorTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -314,6 +314,7 @@ public function collection_urls_can_be_invalidated_by_an_entry()
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->andReturnNull();
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
Expand DownExpand Up@@ -368,6 +369,7 @@ public function collection_urls_can_be_invalidated_by_an_entry_in_a_multisite()
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::get('fr'));
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->andReturnNull();
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
Expand DownExpand Up@@ -417,6 +419,7 @@ public function invalidation_urls_respect_trailing_slash_enforcement()
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->andReturnNull();
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
Expand DownExpand Up@@ -456,6 +459,7 @@ public function entry_urls_are_not_invalidated_by_an_entry_with_a_redirect()
 $m->shouldReceive('collectionHandle')->andReturn('blog');
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->andReturnNull();
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
Expand All@@ -479,6 +483,68 @@ public function entry_urls_are_not_invalidated_by_an_entry_with_a_redirect()
 $this->assertNull($invalidator->invalidate($entry));
 }

 #[Test]
 public function old_entry_url_is_invalidated_when_the_slug_changes()
 {
 $cacher = tap(Mockery::mock(Cacher::class), function ($cacher) {
 $cacher->shouldReceive('invalidateUrls')->with([
 'http://localhost/blog/new-slug',
 'http://localhost/blog/old-slug',
 'http://localhost/blog/old-slug/*',
 ])->once();
 });

 $entry = tap(Mockery::mock(Entry::class), function ($m) {
 $m->shouldReceive('isRedirect')->andReturn(false);
 $m->shouldReceive('absoluteUrl')->andReturn('http://localhost/blog/new-slug');
 $m->shouldReceive('collectionHandle')->andReturn('blog');
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->with('slug')->andReturn('old-slug');
 $m->shouldReceive('slug')->andReturn('new-slug');
 $m->shouldReceive('route')->andReturn('/blog/{slug}');
 $m->shouldReceive('routeData')->andReturn(['slug' => 'new-slug']);
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
 ->andReturn(collect(['parent_uri' => null]));
 });

 $invalidator = new Invalidator($cacher, []);

 $this->assertNull($invalidator->invalidate($entry));
 }

 #[Test]
 public function old_entry_url_is_not_invalidated_when_the_slug_is_unchanged()
 {
 $cacher = tap(Mockery::mock(Cacher::class), function ($cacher) {
 $cacher->shouldReceive('invalidateUrls')->with([
 'http://localhost/blog/my-slug',
 ])->once();
 });

 $entry = tap(Mockery::mock(Entry::class), function ($m) {
 $m->shouldReceive('isRedirect')->andReturn(false);
 $m->shouldReceive('absoluteUrl')->andReturn('http://localhost/blog/my-slug');
 $m->shouldReceive('collectionHandle')->andReturn('blog');
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->with('slug')->andReturn('my-slug');
 $m->shouldReceive('slug')->andReturn('my-slug');
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
 ->andReturn(collect(['parent_uri' => null]));
 });

 $invalidator = new Invalidator($cacher, []);

 $this->assertNull($invalidator->invalidate($entry));
 }

 #[Test]
 public function taxonomy_urls_can_be_invalidated()
 {
Expand DownExpand Up@@ -961,6 +1027,7 @@ public function it_doesnt_recache_when_background_recache_token_is_disabled()
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->andReturnNull();
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
Expand DownExpand Up@@ -1001,6 +1068,7 @@ public function it_recaches_when_background_recache_token_is_enabled()
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->andReturnNull();
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
Expand All@@ -1021,6 +1089,43 @@ public function it_recaches_when_background_recache_token_is_enabled()
 $this->assertNull($invalidator->refresh($entry));
 }

 #[Test]
 public function old_entry_url_is_invalidated_rather_than_recached_when_background_recache_is_enabled()
 {
 config()->set('statamic.static_caching.background_recache', true);

 $cacher = tap(Mockery::mock(Cacher::class), function ($cacher) {
 $cacher->shouldReceive('invalidateUrls')->once()->with([
 'http://localhost/blog/old-slug',
 'http://localhost/blog/old-slug/*',
 ]);
 $cacher->shouldReceive('refreshUrls')->once()->with([
 'http://localhost/blog/new-slug',
 ]);
 });

 $entry = tap(Mockery::mock(Entry::class), function ($m) {
 $m->shouldReceive('isRedirect')->andReturn(false);
 $m->shouldReceive('absoluteUrl')->andReturn('http://localhost/blog/new-slug');
 $m->shouldReceive('collectionHandle')->andReturn('blog');
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->with('slug')->andReturn('old-slug');
 $m->shouldReceive('slug')->andReturn('new-slug');
 $m->shouldReceive('route')->andReturn('/blog/{slug}');
 $m->shouldReceive('routeData')->andReturn(['slug' => 'new-slug']);
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
 ->andReturn(collect(['parent_uri' => null]));
 });

 $invalidator = new Invalidator($cacher, []);

 $this->assertNull($invalidator->refresh($entry));
 }

 #[Test]
 public function it_calls_the_custom_invalidate_method_when_background_recache_is_enabled()
 {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
})();
[6.x] Fix old slug not removed from static cache when changing slugs by mynetx · Pull Request #15021 · statamic/cms · GitHub
Skip to content
[6.x] Fix old slug not removed from static cache when changing slugs#15021

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.

 Sign up for GitHub

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

mynetx
wants to merge
1
commit into

base:6.x
Choose a base branch

from


+138

−1

 Open


[6.x] Fix old slug not removed from static cache when changing slugs
#15021
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


34 changes: 33 additions & 1 deletion
src/StaticCaching/DefaultInvalidator.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
use Statamic\Contracts\Entries\Entry;
use Statamic\Contracts\Forms\Form;
use Statamic\Contracts\Globals\Variables;
use Statamic\Contracts\Routing\UrlBuilder;
use Statamic\Contracts\Structures\Nav;
use Statamic\Contracts\Structures\NavTree;
use Statamic\Facades\Antlers;
Expand All@@ -32,6 +33,11 @@ public function __construct(Cacher $cacher, $rules = [])

 public function invalidate($item)
 {
 // Old URLs no longer resolve so they cannot be recached, only invalidated.
 if ($this->refreshing && ($oldUrls = $this->getItemOldUrls($item))) {
 $this->cacher->invalidateUrls($oldUrls);
 }

 if ($this->rules === 'all') {
 $this->refreshing
 ? $this->cacher->refreshUrls($this->cacher->getUrls()->all())
Expand All@@ -44,7 +50,7 @@ public function invalidate($item)

 $this->refreshing
 ? $this->cacher->refreshUrls($urls)
 : $this->cacher->invalidateUrls($urls);
 : $this->cacher->invalidateUrls([...$urls, ...$this->getItemOldUrls($item)]);
 }

 public function refresh($item)
Expand DownExpand Up@@ -92,6 +98,32 @@ protected function getItemUrls($item)
 return $urls;
 }

 protected function getItemOldUrls($item)
 {
 return $item instanceof Entry ? $this->getOldEntryUrls($item) : [];
 }

 protected function getOldEntryUrls($entry)
 {
 if (
 is_null($originalSlug = $entry->getOriginal('slug'))
 || $originalSlug === $entry->slug()
 || ! ($route = $entry->route())
 ) {
 return [];
 }

 $uri = app(UrlBuilder::class)->content($entry)->merge([
 'parent_uri' => $entry->parent()?->uri(),
 'slug' => $originalSlug,
 ])->build($route);

 $oldUrl = URL::tidy($entry->site()->url().'/'.$uri);

 // Anything cached under the old URL (descendants, mounted collections) is stale too.
 return [$oldUrl, Str::finish($oldUrl, '/').'*'];
 }

 protected function getFormUrls($form)
 {
 $rules = collect(Arr::get($this->rules, "forms.{$form->handle()}.urls"));
Expand Down

105 changes: 105 additions & 0 deletions
tests/StaticCaching/DefaultInvalidatorTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -314,6 +314,7 @@ public function collection_urls_can_be_invalidated_by_an_entry()
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->andReturnNull();
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
Expand DownExpand Up@@ -368,6 +369,7 @@ public function collection_urls_can_be_invalidated_by_an_entry_in_a_multisite()
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::get('fr'));
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->andReturnNull();
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
Expand DownExpand Up@@ -417,6 +419,7 @@ public function invalidation_urls_respect_trailing_slash_enforcement()
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->andReturnNull();
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
Expand DownExpand Up@@ -456,6 +459,7 @@ public function entry_urls_are_not_invalidated_by_an_entry_with_a_redirect()
 $m->shouldReceive('collectionHandle')->andReturn('blog');
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->andReturnNull();
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
Expand All@@ -479,6 +483,68 @@ public function entry_urls_are_not_invalidated_by_an_entry_with_a_redirect()
 $this->assertNull($invalidator->invalidate($entry));
 }

 #[Test]
 public function old_entry_url_is_invalidated_when_the_slug_changes()
 {
 $cacher = tap(Mockery::mock(Cacher::class), function ($cacher) {
 $cacher->shouldReceive('invalidateUrls')->with([
 'http://localhost/blog/new-slug',
 'http://localhost/blog/old-slug',
 'http://localhost/blog/old-slug/*',
 ])->once();
 });

 $entry = tap(Mockery::mock(Entry::class), function ($m) {
 $m->shouldReceive('isRedirect')->andReturn(false);
 $m->shouldReceive('absoluteUrl')->andReturn('http://localhost/blog/new-slug');
 $m->shouldReceive('collectionHandle')->andReturn('blog');
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->with('slug')->andReturn('old-slug');
 $m->shouldReceive('slug')->andReturn('new-slug');
 $m->shouldReceive('route')->andReturn('/blog/{slug}');
 $m->shouldReceive('routeData')->andReturn(['slug' => 'new-slug']);
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
 ->andReturn(collect(['parent_uri' => null]));
 });

 $invalidator = new Invalidator($cacher, []);

 $this->assertNull($invalidator->invalidate($entry));
 }

 #[Test]
 public function old_entry_url_is_not_invalidated_when_the_slug_is_unchanged()
 {
 $cacher = tap(Mockery::mock(Cacher::class), function ($cacher) {
 $cacher->shouldReceive('invalidateUrls')->with([
 'http://localhost/blog/my-slug',
 ])->once();
 });

 $entry = tap(Mockery::mock(Entry::class), function ($m) {
 $m->shouldReceive('isRedirect')->andReturn(false);
 $m->shouldReceive('absoluteUrl')->andReturn('http://localhost/blog/my-slug');
 $m->shouldReceive('collectionHandle')->andReturn('blog');
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->with('slug')->andReturn('my-slug');
 $m->shouldReceive('slug')->andReturn('my-slug');
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
 ->andReturn(collect(['parent_uri' => null]));
 });

 $invalidator = new Invalidator($cacher, []);

 $this->assertNull($invalidator->invalidate($entry));
 }

 #[Test]
 public function taxonomy_urls_can_be_invalidated()
 {
Expand DownExpand Up@@ -961,6 +1027,7 @@ public function it_doesnt_recache_when_background_recache_token_is_disabled()
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->andReturnNull();
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
Expand DownExpand Up@@ -1001,6 +1068,7 @@ public function it_recaches_when_background_recache_token_is_enabled()
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->andReturnNull();
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
Expand All@@ -1021,6 +1089,43 @@ public function it_recaches_when_background_recache_token_is_enabled()
 $this->assertNull($invalidator->refresh($entry));
 }

 #[Test]
 public function old_entry_url_is_invalidated_rather_than_recached_when_background_recache_is_enabled()
 {
 config()->set('statamic.static_caching.background_recache', true);

 $cacher = tap(Mockery::mock(Cacher::class), function ($cacher) {
 $cacher->shouldReceive('invalidateUrls')->once()->with([
 'http://localhost/blog/old-slug',
 'http://localhost/blog/old-slug/*',
 ]);
 $cacher->shouldReceive('refreshUrls')->once()->with([
 'http://localhost/blog/new-slug',
 ]);
 });

 $entry = tap(Mockery::mock(Entry::class), function ($m) {
 $m->shouldReceive('isRedirect')->andReturn(false);
 $m->shouldReceive('absoluteUrl')->andReturn('http://localhost/blog/new-slug');
 $m->shouldReceive('collectionHandle')->andReturn('blog');
 $m->shouldReceive('descendants')->andReturn(collect());
 $m->shouldReceive('site')->andReturn(Site::default());
 $m->shouldReceive('parent')->andReturnNull();
 $m->shouldReceive('getOriginal')->with('slug')->andReturn('old-slug');
 $m->shouldReceive('slug')->andReturn('new-slug');
 $m->shouldReceive('route')->andReturn('/blog/{slug}');
 $m->shouldReceive('routeData')->andReturn(['slug' => 'new-slug']);
 $m->shouldReceive('toAugmentedCollection')
 ->andReturnSelf()
 ->shouldReceive('merge')
 ->andReturn(collect(['parent_uri' => null]));
 });

 $invalidator = new Invalidator($cacher, []);

 $this->assertNull($invalidator->refresh($entry));
 }

 #[Test]
 public function it_calls_the_custom_invalidate_method_when_background_recache_is_enabled()
 {
Expand Down
Loading