[6.x] Ensure set preview images are updated when assets are renamed/replaced/deleted

src/Assets/AssetReferenceUpdater.php

@@ -3,7 +3,9 @@
 namespace Statamic\Assets;
 
 use Statamic\Data\DataReferenceUpdater;
+use Statamic\Fieldtypes\Sets;
 use Statamic\Support\Arr;
+use Statamic\Support\Str;
 
 class AssetReferenceUpdater extends DataReferenceUpdater
 {
@@ -65,4 +67,70 @@ protected function recursivelyUpdateFields($fields, $dottedPrefix = null)
 
         $this->updateNestedFieldValues($fields, $dottedPrefix);
     }
+
+    /**
+     * Update fields in blueprints and fieldsets.
+     *
+     * @return void
+     */
+    protected function updateBlueprintFields()
+    {
+        if (
+            ! ($config = Sets::previewImageConfig())
+            || $this->container !== $config['container']
+            || ! Str::startsWith($this->originalValue, $config['folder'].'/')
+        ) {
+            return;
+        }
+
+        $contents = $this->item->contents();
+
+        $fieldPaths = $this->findFieldsInBlueprintContents($contents, fieldtypes: ['bard', 'replicator']);
+
+        foreach ($fieldPaths as $fieldPath) {
+            $fieldContents = Arr::get($contents, $fieldPath);
+
+            if (! isset($fieldContents['sets'])) {
+                continue;
+            }
+
+            $fieldContents['sets'] = collect($fieldContents['sets'])
+                ->map(function ($setGroup) {
+                    if (! isset($setGroup['sets'])) {
+                        return $setGroup;
+                    }
+
+                    $setGroup['sets'] = collect($setGroup['sets'])
+                        ->map(function ($set) {
+                            if (isset($set['image'])) {
+                                $fullPath = Sets::previewImageConfig()['folder'].'/'.$set['image'];
+
+                                if ($fullPath !== $this->originalValue) {
+                                    return $set;
+                                }
+
+                                if (Str::startsWith($this->newValue, Sets::previewImageConfig()['folder'].'/')) {
+                                    $set['image'] = Str::after($this->newValue, Sets::previewImageConfig()['folder'].'/');
+                                } else {
+                                    unset($set['image']);
+                                }
+
+                                $this->updated = true;
+                            }
+
+                            return $set;
+                        })
+                        ->all();
+
+                    return $setGroup;
+                })
+                ->all();
+
+            Arr::set($contents, $fieldPath, $fieldContents);
+        }
+
+        if ($this->updated) {
+            $this->item->setContents($contents);
+        }
+    }
 }

src/Data/DataReferenceUpdater.php

@@ -3,6 +3,9 @@
 namespace Statamic\Data;
 
 use Statamic\Facades\Blink;
+use Statamic\Fields\Blueprint;
+use Statamic\Fields\Fields;
+use Statamic\Fields\Fieldset;
 use Statamic\Fieldtypes\UpdatesReferences;
 use Statamic\Git\Subscriber as GitSubscriber;
 use Statamic\Support\Arr;
@@ -66,7 +69,11 @@ public function updateReferences($originalValue, $newValue)
         $this->originalValue = $originalValue;
         $this->newValue = $newValue;
 
-        $this->recursivelyUpdateFields($this->getTopLevelFields());
+        if ($this->item instanceof Blueprint || $this->item instanceof Fieldset) {
+            $this->updateBlueprintFields();
+        } else {
+            $this->recursivelyUpdateFields($this->getTopLevelFields());
+        }
 
         if ($this->updated) {
             $this->saveItem();
@@ -75,6 +82,46 @@ public function updateReferences($originalValue, $newValue)
         return (bool) $this->updated;
     }
 
+    /**
+     * Update fields in blueprints and fieldsets.
+     *
+     * @return void
+     */
+    abstract protected function updateBlueprintFields();
+
+    /**
+     * Finds fields of a given type in the contents of a blueprint.
+     * Returns dot-notation paths to the fields.
+     *
+     * Note: This uses a simple heuristic that matches any nested array with
+     * a 'type' key whose value is in the given fieldtypes list. While this
+     * could theoretically match non-field structures, in practice blueprint
+     * contents don't contain these strings in other contexts (like validation
+     * rules), and downstream code guards against false matches by checking
+     * for the presence of required keys like 'sets'.
+     *
+     * @param  array  $array
+     * @param  array  $fieldtypes
+     * @param  string|null  $dottedPrefix
+     * @param  array  $fieldPaths
+     * @return array
+     */
+    protected function findFieldsInBlueprintContents($array, $fieldtypes, $dottedPrefix = '', &$fieldPaths = [])
+    {
+        foreach ($array as $key => $value) {
+            if (is_array($value)) {
+                $fieldPath = $dottedPrefix ? "$dottedPrefix.$key" : $key;
+                $this->findFieldsInBlueprintContents($value, $fieldtypes, $fieldPath, $fieldPaths);
+            }
+
+            if (is_string($value) && $key === 'type' && in_array($value, $fieldtypes)) {
+                $fieldPaths[] = $dottedPrefix;
+            }
+        }
+
+        return $fieldPaths;
+    }
+
     /**
      * Get top level fields off item blueprint.
      *

src/Fields/BlueprintRepository.php

@@ -6,6 +6,7 @@
 use Exception;
 use Illuminate\Support\Collection;
 use Statamic\Exceptions\BlueprintNotFoundException;
+use Statamic\Facades;
 use Statamic\Facades\Blink;
 use Statamic\Facades\File;
 use Statamic\Facades\Path;
@@ -23,6 +24,24 @@ class BlueprintRepository
     protected $fallbacks = [];
     protected $additionalNamespaces = [];
 
+    public function all()
+    {
+        $namespaces = [
+            ...Facades\Collection::all()->map(fn ($collection) => "collections/{$collection->handle()}")->all(),
+            ...Facades\Taxonomy::all()->map(fn ($taxonomy) => "taxonomies/{$taxonomy->handle()}")->all(),
+            'navigation', 'assets', 'globals', 'forms',
+            ...$this->getAdditionalNamespaces()->keys()->all(),
+        ];
+
+        $rootLevelBlueprints = collect(['user', 'user_group'])
+            ->map(fn ($handle) => $this->find($handle))
+            ->filter();
+
+        return $rootLevelBlueprints->merge(
+            collect($namespaces)->flatMap(fn ($namespace) => $this->in($namespace)->values())
+        );
+    }
+
     public function setDirectories(string|array $directories)
     {
         if (is_string($directories)) {
@@ -334,7 +353,10 @@ protected function makeBlueprintFromFile($path, $namespace = null)
                 ->setInitialPath($path)
                 ->setNamespace($namespace ?? null)
                 ->setContents($contents);
-        });
+        // Clear any parent that may have been set on the blueprint during a previous
+        // find() call. The blink cache returns the same instance, so without this,
+        // iterating blueprints via all() could produce instances with stale parents.
+        })->setParent(null);
     }
 
     protected function getNamespaceAndHandle($blueprint)

src/Fields/FieldsetRepository.php

@@ -172,6 +172,8 @@ public function save(Fieldset $fieldset)
             "{$directory}/{$handle}.yaml",
             YAML::dump($fieldset->contents())
         );
+
+        $this->fieldsets[$fieldset->handle()] = $fieldset;
     }
 
     public function delete(Fieldset $fieldset)
@@ -181,6 +183,8 @@ public function delete(Fieldset $fieldset)
         }
 
         File::delete($fieldset->path());
+
+        unset($this->fieldsets[$fieldset->handle()]);
     }
 
     public function reset(Fieldset $fieldset)

src/Listeners/UpdateAssetReferences.php

@@ -9,6 +9,9 @@
 use Statamic\Events\AssetReplaced;
 use Statamic\Events\AssetSaved;
 use Statamic\Events\Subscriber;
+use Statamic\Facades\Blueprint;
+use Statamic\Facades\Fieldset;
+use Statamic\Fieldtypes\Sets;
 
 class UpdateAssetReferences extends Subscriber implements ShouldQueue
 {
@@ -112,6 +115,32 @@ protected function replaceReferences($asset, $originalPath, $newPath)
                 }
             });
 
+        // Only enumerate blueprints/fieldsets when set preview images are configured
+        // and the asset is in the configured container to avoid unnecessary disk I/O.
+        if (($config = Sets::previewImageConfig()) && $container === $config['container']) {
+            Blueprint::all()
+                ->each(function ($blueprint) use ($container, $originalPath, $newPath, &$hasUpdatedItems) {
+                    $updated = AssetReferenceUpdater::item($blueprint)
+                        ->filterByContainer($container)
+                        ->updateReferences($originalPath, $newPath);
+
+                    if ($updated) {
+                        $hasUpdatedItems = true;
+                    }
+                });
+
+            Fieldset::all()
+                ->each(function ($fieldset) use ($container, $originalPath, $newPath, &$hasUpdatedItems) {
+                    $updated = AssetReferenceUpdater::item($fieldset)
+                        ->filterByContainer($container)
+                        ->updateReferences($originalPath, $newPath);
+
+                    if ($updated) {
+                        $hasUpdatedItems = true;
+                    }
+                });
+        }
+
         if ($hasUpdatedItems) {
             AssetReferencesUpdated::dispatch($asset);
         }

src/Taxonomies/TermReferenceUpdater.php

@@ -65,4 +65,14 @@ protected function recursivelyUpdateFields($fields, $dottedPrefix = null)
 
         $this->updateNestedFieldValues($fields, $dottedPrefix);
     }
+
+    /**
+     * Update fields in blueprints and fieldsets.
+     *
+     * @return void
+     */
+    protected function updateBlueprintFields()
+    {
+        //
+    }
 }

tests/Assets/AssetFolderTest.php

@@ -1174,6 +1174,7 @@ private function containerWithDisk()
         Storage::fake('local');
 
         $container = Facades\AssetContainer::make('test')->disk('local');
+        Facades\AssetContainer::shouldReceive('find')->with('assets')->andReturn(null);
         Facades\AssetContainer::shouldReceive('findByHandle')->with('test')->andReturn($container);
         Facades\AssetContainer::shouldReceive('save')->with($container);
 

tests/Assets/AssetTest.php

@@ -1199,6 +1199,7 @@ public function it_can_be_moved_to_another_folder_with_a_new_filename()
         $disk->put('old/asset.txt', 'The asset contents');
         $container = Facades\AssetContainer::make('test')->disk('local');
         Facades\AssetContainer::shouldReceive('save')->with($container);
+        Facades\AssetContainer::shouldReceive('find')->with('assets')->andReturnNull();
         Facades\AssetContainer::shouldReceive('findByHandle')->with('test')->andReturn($container);
         $asset = $container->makeAsset('old/asset.txt')->data(['foo' => 'bar']);
         $asset->save();
@@ -1239,6 +1240,7 @@ public function it_lowercases_when_moving_to_another_folder_with_a_new_filename(
         $disk->put('old/asset.txt', 'The asset contents');
         $container = Facades\AssetContainer::make('test')->disk('local');
         Facades\AssetContainer::shouldReceive('save')->with($container);
+        Facades\AssetContainer::shouldReceive('find')->with('assets')->andReturnNull();
         Facades\AssetContainer::shouldReceive('findByHandle')->with('test')->andReturn($container);
         $asset = $container->makeAsset('old/asset.txt');
         $asset->save();
@@ -1262,6 +1264,7 @@ public function it_doesnt_lowercase_moved_files_when_configured()
         $disk->put('old/asset.txt', 'The asset contents');
         $container = Facades\AssetContainer::make('test')->disk('local');
         Facades\AssetContainer::shouldReceive('save')->with($container);
+        Facades\AssetContainer::shouldReceive('find')->with('assets')->andReturnNull();
         Facades\AssetContainer::shouldReceive('findByHandle')->with('test')->andReturn($container);
         $asset = $container->makeAsset('old/asset.txt');
         $asset->save();

tests/Fields/BlueprintRepositoryTest.php

@@ -10,10 +10,13 @@
 use Statamic\Fields\Blueprint;
 use Statamic\Fields\BlueprintRepository;
 use Statamic\Support\FileCollection;
+use Tests\PreventSavingStacheItemsToDisk;
 use Tests\TestCase;
 
 class BlueprintRepositoryTest extends TestCase
 {
+    use PreventSavingStacheItemsToDisk;
+
     private $repo;
 
     public function setUp(): void
@@ -26,6 +29,58 @@ public function setUp(): void
         Facades\Blueprint::swap($this->repo);
     }
 
+    #[Test]
+    public function it_gets_all_blueprints()
+    {
+        $this->repo->setDirectories($this->fakeStacheDirectory.'/dev-null/blueprints');
+
+        $collection = tap(Facades\Collection::make('test'))->save();
+        $collection->entryBlueprint()->save();
+
+        $taxonomy = tap(Facades\Taxonomy::make('test'))->save();
+        $taxonomy->termBlueprint()->save();
+
+        $nav = tap(Facades\Nav::make('test'))->save();
+        $nav->blueprint()->save();
+
+        $assetContainer = tap(Facades\AssetContainer::make('test'))->save();
+        $assetContainer->blueprint()->save();
+
+        Facades\GlobalSet::make('test')->save();
+        $this->repo->make('test')->setNamespace('globals')->save();
+
+        $form = tap(Facades\Form::make('test'))->save();
+        $form->blueprint()->save();
+
+        $all = $this->repo->all();
+
+        $this->assertEveryItemIsInstanceOf(Blueprint::class, $all);
+        $this->assertEquals([
+            'collections.test.test',
+            'taxonomies.test.test',
+            'navigation.test',
+            'assets.test',
+            'globals.test',
+            'forms.test',
+        ], $all->map->fullyQualifiedHandle()->all());
+    }
+
+    #[Test]
+    public function it_includes_user_and_user_group_blueprints_in_all()
+    {
+        $this->repo->setDirectories($this->fakeStacheDirectory.'/dev-null/blueprints');
+
+        // Create user and user_group blueprints
+        $this->repo->make('user')->save();
+        $this->repo->make('user_group')->save();
+
+        $all = $this->repo->all();
+
+        $this->assertEveryItemIsInstanceOf(Blueprint::class, $all);
+        $this->assertContains('user', $all->map->fullyQualifiedHandle()->all());
+        $this->assertContains('user_group', $all->map->fullyQualifiedHandle()->all());
+    }
+
     #[Test]
     public function it_gets_a_blueprint()
     {

tests/Git/GitEventTest.php

@@ -613,6 +613,7 @@ public function it_batches_asset_references_changes_into_one_commit()
                 ],
             ]);
 
+        BlueprintRepository::shouldReceive('all')->andReturn(collect([$blueprint]));
         BlueprintRepository::shouldReceive('in')->with('collections/pages')->andReturn(collect([$blueprint]));
 
         foreach (range(1, 3) as $i) {