[6.x] Fix cache invalidation when using custom fields in URI route (#14564)

Author: duncanmcclean

src/Stache/Stores/CollectionEntriesStore.php

@@ -215,9 +215,11 @@ protected function writeItemToDisk($item)
                 break;
             }
 
-            $itemFromDisk = $this->makeItemFromFile($path, $contents);
+            // Only parse the ID from the file rather than using makeItemFromFile,
+            // which would put a stale entry into the structure-entries blink store.
+            $id = Arr::get(YAML::file($path)->parse($contents), 'id');
 
-            if ($item->id() == $itemFromDisk->id()) {
+            if ($item->id() == $id) {
                 break;
             }
 
@@ -269,7 +271,7 @@ public function updateParents($ids = null)
 
     private function updateEntriesWithinIndex($index, $ids)
     {
-        if (empty($ids)) {
+        if (collect($ids)->isEmpty()) {
             return $index->update();
         }
 
@@ -281,7 +283,7 @@ private function updateEntriesWithinIndex($index, $ids)
 
     private function updateEntriesWithinStore($ids)
     {
-        if (empty($ids)) {
+        if (collect($ids)->isEmpty()) {
             $ids = $this->paths()->keys();
         }
 

src/Structures/CollectionStructure.php

@@ -44,6 +44,8 @@ public function entryUri($entry)
             ->keyBy->reference()
             ->get($entry->id());
 
+        $page?->setEntry($entry);
+
         return optional($page)->uri();
     }
 

src/Structures/Page.php

@@ -139,10 +139,12 @@ public function setEntry($reference): self
         if (is_object($reference)) {
             throw_unless($id = $reference->id(), new \Exception('Cannot set an entry without an ID'));
             Blink::store('structure-entries')->put($id, $reference);
+            Blink::store('structure-uris')->forget($id);
             $reference = $id;
         }
 
         $this->reference = $reference;
+        $this->routeData = null;
 
         return $this;
     }

tests/Data/Entries/EntryTest.php

@@ -702,6 +702,31 @@ public static function firstChildRedirectProvider()
         ];
     }
 
+    #[Test]
+    public function structured_entry_uri_updates_when_custom_field_in_route_changes()
+    {
+        $this->setSites([
+            'en' => ['url' => 'http://domain.com/', 'locale' => 'en_US'],
+        ]);
+
+        $collection = tap((new Collection)->handle('pages')->routes('{slug}/{test}'))->save();
+
+        $entry = tap((new Entry)->id('1')->locale('en')->collection($collection)->slug('page')->set('test', 'foo'))->save();
+
+        $collection->structureContents(['expects_root' => false])->save();
+        $collection->structure()->in('en')->tree([['entry' => '1']])->save();
+
+        // Warm the structure caches like they would be in production.
+        Blink::store('entry-uris')->flush();
+        $this->assertEquals('/page/foo', $entry->uri());
+
+        $entry->set('test', 'bar');
+        $entry->save();
+
+        Blink::store('entry-uris')->flush();
+        $this->assertEquals('/page/bar', $entry->uri());
+    }
+
     #[Test]
     public function it_gets_and_sets_supplemental_data()
     {

tests/Data/Structures/CollectionStructureTest.php

@@ -175,6 +175,7 @@ public function it_gets_an_entry_uri()
 
         $page = $this->mock(Page::class);
         $page->shouldReceive('reference')->andReturn('the-entry-id');
+        $page->shouldReceive('setEntry')->once()->andReturnSelf();
         $page->shouldReceive('uri')->andReturn('/the-uri-from-the-page');
 
         $tree = $this->mock(Tree::class);