[5.x] Add ability to reset namespaced blueprints (#9327)

Co-authored-by: Jason Varga <[email protected]>

resources/js/bootstrap/components.js

@@ -60,6 +60,7 @@ import ResourceDeleter from '../components/ResourceDeleter.vue';
 import Stack from '../components/stacks/Stack.vue';
 import StackTest from '../components/stacks/StackTest.vue';
 import CodeBlock from '../components/CodeBlock.vue';
+import BlueprintResetter from '../components/blueprints/BlueprintResetter.vue';
 
 // Third Party
 Vue.component('v-select', vSelect)
@@ -142,3 +143,5 @@ Vue.component('resource-deleter', ResourceDeleter);
 
 Vue.component('stack', Stack);
 Vue.component('stack-test', StackTest);
+
+Vue.component('blueprint-resetter', BlueprintResetter);

resources/js/components/blueprints/BlueprintResetter.vue

@@ -0,0 +1,102 @@
+<template>
+    <confirmation-modal
+        v-if="resetting"
+        :title="modalTitle"
+        :bodyText="modalBody"
+        :buttonText="__('Reset')"
+        :danger="true"
+        @confirm="confirmed"
+        @cancel="cancel"
+    >
+    </confirmation-modal>
+</template>
+
+<script>
+export default {
+
+    props: {
+        resource: {
+            type: Object
+        },
+        resourceTitle: {
+            type: String
+        },
+        route: {
+            type: String,
+        },
+        redirect: {
+            type: String
+        },
+        reload: {
+            type: Boolean
+        }
+    },
+
+    data() {
+        return {
+            resetting: false,
+            redirectFromServer: null,
+        }
+    },
+
+    computed: {
+        title() {
+            return data_get(this.resource, 'title', this.resourceTitle);
+        },
+
+        modalTitle() {
+            return __('Reset :resource', {resource: this.title});
+        },
+
+        modalBody() {
+            return __('Are you sure you want to reset this item?');
+        },
+
+        resetUrl() {
+            let url = data_get(this.resource, 'reset_url', this.route);
+            if (! url) console.error('BlueprintResetter cannot find reset url');
+            return url;
+        },
+
+        redirectUrl() {
+            return this.redirect || this.redirectFromServer;
+        },
+    },
+
+    methods: {
+        confirm() {
+            this.resetting = true;
+        },
+
+        confirmed() {
+            this.$axios.delete(this.resetUrl)
+                .then(response => {
+                    this.redirectFromServer = data_get(response, 'data.redirect');
+                    this.success();
+                })
+                .catch(() => {
+                    this.$toast.error(__('Something went wrong'));
+                });
+        },
+
+        success() {
+            if (this.redirectUrl) {
+                location.href = this.redirectUrl;
+                return;
+            }
+
+            if (this.reload) {
+                location.reload();
+                return;
+            }
+
+            this.$toast.success(__('Reset'));
+            this.$emit('reset');
+        },
+
+        cancel() {
+            this.resetting = false;
+        }
+    }
+}
+</script>

resources/views/blueprints/index.blade.php

@@ -193,6 +193,20 @@
                         <a href="{{ cp_route('blueprints.edit', [$blueprint['namespace'], $blueprint['handle']]) }}">{{ $blueprint['title'] }}</a>
                     </div>
                 </td>
+                <th class="actions-column">
+                    @if ($blueprint['is_resettable'])
+                        <dropdown-list class="dropdown-list">
+                            <dropdown-item :text="__('Reset')" class="warning" @click="$refs[`resetter_{{ $blueprint['namespace'] }}_{{ $blueprint['handle'] }}`].confirm()">
+                                <blueprint-resetter
+                                    ref="resetter_{{ $blueprint['namespace'] }}_{{ $blueprint['handle'] }}"
+                                    :resource='@json($blueprint)'
+                                    reload
+                                >
+                                </blueprint-resetter>
+                            </dropdown-item>
+                        </dropdown-list>
+                    @endif
+                </td>
             </tr>
         @endforeach
         </table>

routes/cp.php

@@ -256,6 +256,7 @@
         Route::get('blueprints', [BlueprintController::class, 'index'])->name('blueprints.index');
         Route::get('blueprints/{namespace}/{handle}', [BlueprintController::class, 'edit'])->name('blueprints.edit');
         Route::patch('blueprints/{namespace}/{handle}', [BlueprintController::class, 'update'])->name('blueprints.update');
+        Route::delete('blueprints/{namespace}/{handle}/reset', [BlueprintController::class, 'reset'])->name('blueprints.reset');
         Route::get('fieldtypes', [FieldtypesController::class, 'index']);
     });
 

src/Events/BlueprintReset.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Statamic\Events;
+
+use Statamic\Contracts\Git\ProvidesCommitMessage;
+
+class BlueprintReset extends Event implements ProvidesCommitMessage
+{
+    public $blueprint;
+
+    public function __construct($blueprint)
+    {
+        $this->blueprint = $blueprint;
+    }
+
+    public function commitMessage()
+    {
+        return __('Blueprint reset', [], config('statamic.git.locale'));
+    }
+}

src/Events/Concerns/ListensForContentEvents.php

@@ -19,6 +19,7 @@ trait ListensForContentEvents
         \Statamic\Events\AssetReuploaded::class,
         \Statamic\Events\AssetReferencesUpdated::class,
         \Statamic\Events\BlueprintDeleted::class,
+        \Statamic\Events\BlueprintReset::class,
         \Statamic\Events\BlueprintSaved::class,
         \Statamic\Events\CollectionDeleted::class,
         \Statamic\Events\CollectionSaved::class,

src/Fields/Blueprint.php

@@ -17,6 +17,7 @@
 use Statamic\Events\BlueprintCreating;
 use Statamic\Events\BlueprintDeleted;
 use Statamic\Events\BlueprintDeleting;
+use Statamic\Events\BlueprintReset;
 use Statamic\Events\BlueprintSaved;
 use Statamic\Events\BlueprintSaving;
 use Statamic\Exceptions\DuplicateFieldException;
@@ -414,6 +415,12 @@ public function isDeletable()
         return ! $this->isNamespaced();
     }
 
+    public function isResettable()
+    {
+        return $this->isNamespaced()
+            && File::exists($this->path());
+    }
+
     public function toPublishArray()
     {
         return [
@@ -501,6 +508,15 @@ public function delete()
         return true;
     }
 
+    public function reset()
+    {
+        BlueprintRepository::reset($this);
+
+        BlueprintReset::dispatch($this);
+
+        return true;
+    }
+
     public function ensureField($handle, $fieldConfig, $tab = null, $prepend = false)
     {
         return $this->ensureFieldInTab($handle, $fieldConfig, $tab, $prepend);
@@ -731,6 +747,11 @@ public function toQueryableValue()
         return $this->handle();
     }
 
+    public function resetUrl()
+    {
+        return cp_route('blueprints.reset', [$this->namespace(), $this->handle()]);
+    }
+
     public function writeFile($path = null)
     {
         File::put($path ?? $this->buildPath(), $this->fileContents());

src/Fields/BlueprintRepository.php

@@ -130,6 +130,15 @@ public function delete(Blueprint $blueprint)
         $blueprint->deleteFile();
     }
 
+    public function reset(Blueprint $blueprint)
+    {
+        if (! $blueprint->isNamespaced()) {
+            throw new \Exception('Non-namespaced blueprints cannot be reset');
+        }
+
+        File::delete($blueprint->path());
+    }
+
     private function clearBlinkCaches()
     {
         Blink::store(self::BLINK_FOUND)->flush();

src/Http/Controllers/CP/Fields/BlueprintController.php

@@ -29,6 +29,8 @@ public function index()
                                 'handle' => $blueprint->handle(),
                                 'namespace' => $blueprint->namespace(),
                                 'title' => $blueprint->title(),
+                                'reset_url' => $blueprint->resetUrl(),
+                                'is_resettable' => $blueprint->isResettable(),
                             ];
                         })
                         ->sortBy('title')
@@ -73,4 +75,17 @@ public function update(Request $request, $namespace, $handle)
 
         $this->updateBlueprint($request, $blueprint);
     }
+
+    public function reset($namespace, $handle)
+    {
+        $blueprint = Blueprint::find($namespace.'::'.$handle);
+
+        if (! $blueprint) {
+            throw new NotFoundHttpException;
+        }
+
+        $blueprint->reset();
+
+        return response('');
+    }
 }

tests/Fields/BlueprintRepositoryTest.php

@@ -356,6 +356,19 @@ public function it_gets_blueprints_in_a_custom_namespace_with_overrides()
         $this->assertEquals(['First Blueprint', 'Overridden Second Blueprint'], $blueprints->map->title()->values()->all());
     }
 
+    #[Test]
+    public function it_resets_a_namespaced_blueprint()
+    {
+        File::shouldReceive('exists')->with('/path/to/resources/blueprints/vendor/foo/test.yaml')->andReturnTrue();
+        File::shouldReceive('get')->with('/path/to/resources/blueprints/vendor/foo/test.yaml')->once()->andReturn('title: Overwritten Test Blueprint');
+        File::shouldReceive('delete')->once();
+
+        $this->repo->addNamespace('foo', 'foo');
+        $blueprint = $this->repo->find('foo::test');
+
+        $this->repo->reset($blueprint);
+    }
+
     #[Test]
     public function it_sets_the_namespace_when_passed_when_making()
     {