[5.x] Invalidate nav's URL cache when collection/taxonomy/etc is created (#13297)

Author: duncanmcclean

src/Listeners/InvalidateNavCache.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Statamic\Listeners;
+
+use Statamic\Events\AssetContainerCreated;
+use Statamic\Events\CollectionCreated;
+use Statamic\Events\GlobalSetCreated;
+use Statamic\Events\NavCreated;
+use Statamic\Events\Subscriber;
+use Statamic\Events\TaxonomyCreated;
+use Statamic\Facades\CP\Nav;
+
+class InvalidateNavCache extends Subscriber
+{
+    protected $listeners = [
+        CollectionCreated::class => 'invalidate',
+        NavCreated::class => 'invalidate',
+        TaxonomyCreated::class => 'invalidate',
+        AssetContainerCreated::class => 'invalidate',
+        GlobalSetCreated::class => 'invalidate',
+    ];
+
+    public function invalidate($event): void
+    {
+        Nav::clearCachedUrls();
+    }
+}

src/Providers/EventServiceProvider.php

@@ -37,6 +37,7 @@ class EventServiceProvider extends ServiceProvider
         \Statamic\Listeners\GeneratePresetImageManipulations::class,
         \Statamic\Listeners\UpdateAssetReferences::class,
         \Statamic\Listeners\UpdateTermReferences::class,
+        \Statamic\Listeners\InvalidateNavCache::class,
     ];
 
     public function register()

tests/CP/Navigation/ActiveNavItemTest.php

@@ -110,17 +110,9 @@ public function it_updates_caches_when_new_child_urls_are_detected_after_resolvi
         // Now let's create a new collection
         Facades\Collection::make('products')->title('Products')->save();
 
-        // Simply building the nav should change what is cached
-        $collectionsChildrenUrls = [
-            'http://localhost/cp/collections/articles',
-            'http://localhost/cp/collections/pages',
-        ];
-        $this->assertEquals($collectionsChildrenUrls, Cache::get(NavBuilder::UNRESOLVED_CHILDREN_URLS_CACHE_KEY)->get('content::collections'));
-        $this->assertEquals($collectionsChildrenUrls, Blink::get(NavBuilder::UNRESOLVED_CHILDREN_URLS_CACHE_KEY)->get('content::collections'));
-        collect($collectionsChildrenUrls)->each(function ($url) {
-            $this->assertTrue(Cache::get(NavBuilder::ALL_URLS_CACHE_KEY)->contains($url));
-            $this->assertTrue(Blink::get(NavBuilder::ALL_URLS_CACHE_KEY)->contains($url));
-        });
+        // The InvalidateNavCache subscriber will clear the URLs cache.
+        $this->assertNull(Cache::get(NavBuilder::UNRESOLVED_CHILDREN_URLS_CACHE_KEY));
+        $this->assertNull(Blink::get(NavBuilder::UNRESOLVED_CHILDREN_URLS_CACHE_KEY));
 
         // But if we build the nav again by hitting collections url to resolve its' children, the caches should get updated
         $this

tests/TestCase.php

@@ -38,7 +38,8 @@ protected function setUp(): void
 
         if ($this->shouldPreventNavBeingBuilt) {
             \Statamic\Facades\CP\Nav::shouldReceive('build')->zeroOrMoreTimes()->andReturn(collect());
-            $this->addToAssertionCount(-1); // Dont want to assert this
+            \Statamic\Facades\CP\Nav::shouldReceive('clearCachedUrls')->zeroOrMoreTimes();
+            $this->addToAssertionCount(-2); // Dont want to assert this
         }
 
         $this->addGqlMacros();