[6.x] Support non-revisable fields in entries

lang/en/messages.php

@@ -107,6 +107,7 @@
     'fields_instructions_position_instructions' => 'Show instructions above or below the field.',
     'fields_listable_instructions' => 'Control the listing column visibility.',
     'fields_replicator_preview_instructions' => 'Control preview visibility in Replicator/Bard sets.',
+    'fields_revisable_instructions' => 'Include this field in revisions. When disabled, changes are saved straight to the published entry instead of a working copy. Only applies to top level fields in collection entries. The date, slug and published fields are unaffected.',
     'fields_sortable_instructions' => 'Control if the field should be sortable in listing views.',
     'fields_visibility_instructions' => 'Control field visibility on publish forms.',
     'fieldset_import_fieldset_instructions' => 'The fieldset to be imported.',

src/Entries/Entry.php

@@ -762,7 +762,7 @@ protected function revisionAttributes()
             'slug' => $this->slug(),
             'published' => $this->published(),
             'date' => $this->collection()->dated() && (! $this->hasOrigin() || $this->hasExplicitDate()) ? $this->date()->timestamp : null,
-            'data' => $this->data()->except(['updated_by', 'updated_at'])->all(),
+            'data' => $this->data()->except(['updated_by', 'updated_at', ...$this->nonRevisableFields()])->all(),
         ];
     }
 
@@ -778,7 +778,7 @@ public function makeFromRevision($revision)
 
         $entry
             ->published($attrs['published'])
-            ->data($attrs['data'])
+            ->data(collect($attrs['data'])->merge($this->data()->only($this->nonRevisableFields())))
             ->slug($attrs['slug']);
 
         if ($this->collection()->dated()) {

src/Fields/Field.php

@@ -264,6 +264,19 @@ public function isFilterable()
         return (bool) $this->get('filterable');
     }
 
+    public function isRevisable()
+    {
+        if ($this->visibility() === 'computed') {
+            return true;
+        }
+
+        if (is_null($this->get('revisable'))) {
+            return true;
+        }
+
+        return (bool) $this->get('revisable');
+    }
+
     public function shouldBeDuplicated()
     {
         if (is_null($this->get('duplicate'))) {
@@ -623,6 +636,17 @@ public static function commonFieldOptions(): Fields
                 'width' => 50,
 
             ],
+            'revisable' => [
+                'display' => __('Revisable'),
+                'instructions' => __('statamic::messages.fields_revisable_instructions'),
+                'type' => 'toggle',
+                'validate' => 'boolean',
+                'default' => true,
+                'unless' => [
+                    'visibility' => 'equals computed',
+                ],
+                'width' => 50,
+            ],
         ])->map(fn ($field, $handle) => compact('handle', 'field'))->values()->all();
 
         return new ConfigFields($fields);

src/Http/Controllers/CP/Collections/EntriesController.php

@@ -258,6 +258,11 @@ public function update(Request $request, $collection, $entry)
                 ->user(User::current())
                 ->save();
 
+            // have to save in case there are non-revisable fields
+            if ($saved) {
+                $this->saveNonRevisableFields($entry);
+            }
+
             // catch any changes through RevisionSaving event
             $entry = $entry->fromWorkingCopy();
         } else {
@@ -531,4 +536,23 @@ protected function ensureCollectionIsAvailableOnSite($collection, $site)
             return redirect()->back()->with('error', __('Collection is not available on site ":handle".', ['handle' => $site->handle]));
         }
     }
+
+    private function saveNonRevisableFields(EntryContract $entry): void
+    {
+        $fresh = $entry->fresh();
+        $handles = collect($entry->nonRevisableFields());
+        $values = $entry->data()->only($handles->all());
+
+        // A localization's data only holds the localized handles, so a non-revisable
+        // field missing from it has been synced back to the origin and must be removed.
+        $removed = $handles->diff($values->keys())->filter(fn ($handle) => $fresh->has($handle));
+
+        if ($values->isEmpty() && $removed->isEmpty()) {
+            return;
+        }
+
+        $removed->each(fn ($handle) => $fresh->remove($handle));
+
+        $fresh->merge($values)->updateLastModified(User::current())->save();
+    }
 }

src/Revisions/Revisable.php

@@ -172,6 +172,16 @@ public function revisionsEnabled()
         return config('statamic.revisions.enabled') && Statamic::pro();
     }
 
+    public function nonRevisableFields(): array
+    {
+        return $this->blueprint()
+            ->fields()
+            ->all()
+            ->reject(fn ($field) => $field->isRevisable())
+            ->keys()
+            ->all();
+    }
+
     abstract protected function revisionKey();
 
     abstract protected function revisionAttributes();

tests/Feature/Entries/EntryRevisionsTest.php

@@ -203,7 +203,10 @@ public function it_publishes_an_entry()
     {
         $now = Carbon::parse('2017-02-03');
         Carbon::setTestNow($now);
-        $this->setTestBlueprint('test', ['foo' => ['type' => 'text']]);
+        $this->setTestBlueprint('test', [
+            'foo' => ['type' => 'text'],
+            'bar' => ['type' => 'text', 'revisable' => false],
+        ]);
         $this->setTestRoles(['test' => ['access cp', 'publish blog entries']]);
         $user = User::make()->id('user-1')->assignRole('test')->save();
 
@@ -216,6 +219,7 @@ public function it_publishes_an_entry()
                 'blueprint' => 'test',
                 'title' => 'Title',
                 'foo' => 'bar',
+                'bar' => 'foo',
             ])->create();
 
         tap($entry->makeWorkingCopy(), function ($copy) {
@@ -238,6 +242,7 @@ public function it_publishes_an_entry()
             'blueprint' => 'test',
             'title' => 'Title',
             'foo' => 'foo modified in working copy',
+            'bar' => 'foo',
             'updated_at' => $now->timestamp,
             'updated_by' => $user->id(),
         ], $entry->data()->all());
@@ -535,6 +540,48 @@ public function it_restores_an_unpublished_entrys_contents_to_another_revision()
         $this->assertCount(1, $entry->revisions());
     }
 
+    #[Test]
+    public function it_keeps_non_revisable_fields_when_restoring_an_unpublished_entrys_contents()
+    {
+        $this->setTestBlueprint('test', [
+            'foo' => ['type' => 'text'],
+            'bar' => ['type' => 'text', 'revisable' => false],
+        ]);
+        $this->setTestRoles(['test' => ['access cp', 'edit blog entries']]);
+        $user = User::make()->id('user-1')->assignRole('test')->save();
+
+        tap((new Revision)
+            ->key('collections/blog/en/123')
+            ->date(Carbon::createFromTimestamp('1553546421', config('app.timezone')))
+            ->attributes([
+                'published' => true,
+                'slug' => 'existing-slug',
+                'data' => ['foo' => 'existing foo'],
+            ]))->save();
+
+        $entry = EntryFactory::id('123')
+            ->slug('test')
+            ->collection('blog')
+            ->published(false)
+            ->data([
+                'blueprint' => 'test',
+                'foo' => 'bar',
+                'bar' => 'not tracked by revisions',
+                'stale' => 'not in the revision',
+            ])->create();
+
+        $this
+            ->actingAs($user)
+            ->restore($entry, ['revision' => '1553546421'])
+            ->assertOk()
+            ->assertSessionHas('success');
+
+        $entry = Entry::find($entry->id());
+        $this->assertEquals('existing foo', $entry->get('foo'));
+        $this->assertEquals('not tracked by revisions', $entry->get('bar'));
+        $this->assertFalse($entry->has('stale'));
+    }
+
     #[Test]
     public function localized_entry_with_inherited_localizable_date_keeps_following_its_origin_when_reconstructed_from_revision()
     {