Ensure moved/removed entries are statically invalidated

Author: ryanmitchell

src/StaticCaching/Invalidate.php

@@ -9,6 +9,7 @@
 use Statamic\Events\BlueprintSaved;
 use Statamic\Events\CollectionTreeDeleted;
 use Statamic\Events\CollectionTreeSaved;
+use Statamic\Events\CollectionTreeSaving;
 use Statamic\Events\EntryDeleting;
 use Statamic\Events\EntrySaved;
 use Statamic\Events\EntryScheduleReached;
@@ -22,6 +23,7 @@
 use Statamic\Events\NavSaved;
 use Statamic\Events\NavTreeDeleted;
 use Statamic\Events\NavTreeSaved;
+use Statamic\Facades\Entry;
 use Statamic\Facades\Form;
 
 class Invalidate implements ShouldQueue
@@ -42,6 +44,7 @@ class Invalidate implements ShouldQueue
         NavDeleted::class => 'invalidateNav',
         FormSaved::class => 'refreshForm',
         FormDeleted::class => 'invalidateForm',
+        CollectionTreeSaving::class => 'invalidateMovedOrRemovedEntries',
         CollectionTreeSaved::class => 'invalidateCollectionByTree',
         CollectionTreeDeleted::class => 'invalidateCollectionByTree',
         NavTreeSaved::class => 'refreshNavByTree',
@@ -122,6 +125,19 @@ public function refreshForm($event)
         $this->invalidator->refresh($event->form);
     }
 
+    public function invalidateMovedOrRemovedEntries($event)
+    {
+        $diff = $event->tree->diff();
+
+        $entryIds = array_merge($diff->removed(), $diff->ancestryChanged());
+
+        foreach ($entryIds as $id) {
+            if ($entry = Entry::find($id)) {
+                $this->invalidator->invalidate($entry);
+            }
+        }
+    }
+
     public function invalidateCollectionByTree($event)
     {
         $this->invalidator->invalidate($event->tree);

tests/StaticCaching/InvalidateTest.php

@@ -4,10 +4,15 @@
 
 use Mockery;
 use PHPUnit\Framework\Attributes\Test;
+use Statamic\Contracts\Entries\Entry;
 use Statamic\Events\BlueprintSaved;
+use Statamic\Events\CollectionTreeSaving;
+use Statamic\Facades\Entry as EntryFacade;
 use Statamic\Facades\Form;
 use Statamic\StaticCaching\Invalidate;
 use Statamic\StaticCaching\Invalidator;
+use Statamic\Structures\CollectionTree;
+use Statamic\Structures\CollectionTreeDiff;
 use Tests\PreventSavingStacheItemsToDisk;
 use Tests\TestCase;
 
@@ -30,4 +35,97 @@ public function it_invalidates_a_form_when_its_blueprint_is_saved()
 
         $invalidate->invalidateByBlueprint($event);
     }
+
+    #[Test]
+    public function it_invalidates_removed_entries_when_collection_tree_is_saving()
+    {
+        $entry1 = Mockery::mock(Entry::class);
+        $entry2 = Mockery::mock(Entry::class);
+
+        EntryFacade::shouldReceive('find')->with('entry-1')->andReturn($entry1);
+        EntryFacade::shouldReceive('find')->with('entry-2')->andReturn($entry2);
+
+        $diff = Mockery::mock(CollectionTreeDiff::class);
+        $diff->shouldReceive('removed')->andReturn(['entry-1', 'entry-2']);
+        $diff->shouldReceive('ancestryChanged')->andReturn([]);
+
+        $tree = Mockery::mock(CollectionTree::class);
+        $tree->shouldReceive('diff')->andReturn($diff);
+
+        $event = new CollectionTreeSaving($tree);
+
+        $invalidator = Mockery::mock(Invalidator::class);
+        $invalidator->shouldReceive('invalidate')->with($entry1)->once();
+        $invalidator->shouldReceive('invalidate')->with($entry2)->once();
+
+        $invalidate = new Invalidate($invalidator);
+
+        $invalidate->invalidateMovedOrRemovedCollectionEntries($event);
+    }
+
+    #[Test]
+    public function it_invalidates_entries_with_changed_ancestry_when_collection_tree_is_saving()
+    {
+        $entry = Mockery::mock(Entry::class);
+
+        EntryFacade::shouldReceive('find')->with('entry-1')->andReturn($entry);
+
+        $diff = Mockery::mock(CollectionTreeDiff::class);
+        $diff->shouldReceive('removed')->andReturn([]);
+        $diff->shouldReceive('ancestryChanged')->andReturn(['entry-1']);
+
+        $tree = Mockery::mock(CollectionTree::class);
+        $tree->shouldReceive('diff')->andReturn($diff);
+
+        $event = new CollectionTreeSaving($tree);
+
+        $invalidator = Mockery::mock(Invalidator::class);
+        $invalidator->shouldReceive('invalidate')->with($entry)->once();
+
+        $invalidate = new Invalidate($invalidator);
+
+        $invalidate->invalidateMovedOrRemovedCollectionEntries($event);
+    }
+
+    #[Test]
+    public function it_does_not_invalidate_entries_only_reordered_within_same_parent_when_collection_tree_is_saving()
+    {
+        $diff = Mockery::mock(CollectionTreeDiff::class);
+        $diff->shouldReceive('removed')->andReturn([]);
+        $diff->shouldReceive('ancestryChanged')->andReturn([]);
+
+        $tree = Mockery::mock(CollectionTree::class);
+        $tree->shouldReceive('diff')->andReturn($diff);
+
+        $event = new CollectionTreeSaving($tree);
+
+        $invalidator = Mockery::mock(Invalidator::class);
+        $invalidator->shouldNotReceive('invalidate');
+
+        $invalidate = new Invalidate($invalidator);
+
+        $invalidate->invalidateMovedOrRemovedCollectionEntries($event);
+    }
+
+    #[Test]
+    public function it_skips_entries_that_cannot_be_found_when_collection_tree_is_saving()
+    {
+        EntryFacade::shouldReceive('find')->with('missing-entry')->andReturn(null);
+
+        $diff = Mockery::mock(CollectionTreeDiff::class);
+        $diff->shouldReceive('removed')->andReturn(['missing-entry']);
+        $diff->shouldReceive('ancestryChanged')->andReturn([]);
+
+        $tree = Mockery::mock(CollectionTree::class);
+        $tree->shouldReceive('diff')->andReturn($diff);
+
+        $event = new CollectionTreeSaving($tree);
+
+        $invalidator = Mockery::mock(Invalidator::class);
+        $invalidator->shouldNotReceive('invalidate');
+
+        $invalidate = new Invalidate($invalidator);
+
+        $invalidate->invalidateMovedOrRemovedCollectionEntries($event);
+    }
 }