Prevent null values from being saved to data (#412)

Author: ryanmitchell

src/Entries/Entry.php

@@ -132,6 +132,8 @@ public static function makeModelFromContract(EntryContract $source)
             $attributes['data']->put('template', $source->template);
         }
 
+        $attributes['data'] = $attributes['data']->filter(fn ($v) => $v !== null);
+
         foreach ($dataMappings as $key) {
             $attributes[$key] = $data->get($key);
         }

src/Forms/Form.php

@@ -40,7 +40,7 @@ public static function makeModelFromContract(Contract $source)
                 'store'    => $source->store(),
                 'email'    => $source->email(),
                 'honeypot' => $source->honeypot(),
-                'data' => $source->data(),
+                'data' => $source->data()->filter(fn ($v) => $v !== null),
             ],
         ]);
     }

src/Forms/Submission.php

@@ -35,7 +35,7 @@ public function toModel()
         $model = $class::findOrNew($this->id());
 
         return (! empty($model->id)) ? $model->fill([
-            'data' => $this->data,
+            'data' => $this->data->filter(fn ($v) => $v !== null),
         ]) : $model->fill([
             'id' => $this->id(),
             'data' => $this->data,

src/Globals/Variables.php

@@ -39,7 +39,7 @@ public static function makeModelFromContract(Contract $source)
             'handle' => $source->globalSet()->handle(),
             'locale' => $source->locale,
         ])->fill([
-            'data'   => $data,
+            'data'   => $data->filter(fn ($v) => $v !== null),
             'origin' => $source->hasOrigin() ? $source->origin()->locale() : null,
         ]);
     }

src/Taxonomies/Term.php

@@ -82,7 +82,7 @@ public static function makeModelFromContract(Contract $source)
         ])->fill([
             'slug'       => $source->slug(),
             'uri'        => $source->uri(),
-            'data'       => $data,
+            'data'       => collect($data)->filter(fn ($v) => $v !== null),
             'updated_at' => $source->lastModified(),
         ]);
     }

tests/Entries/EntryTest.php

@@ -328,4 +328,22 @@ public function saving_an_entry_updates_the_uri()
         $this->assertSame('/the-new-slug', $entry->uri());
         $this->assertSame('/the-new-slug', $entry->model()->uri);
     }
+
+    #[Test]
+    public function null_values_are_removed_from_data()
+    {
+        Collection::make('blog')->title('blog')
+            ->routes('{parent_uri}/{slug}')
+            ->save();
+
+        $entry = (new Entry)
+            ->id('1.0')
+            ->collection('blog')
+            ->slug('the-slug')
+            ->data(['foo' => 'bar', 'null_value' => null]);
+
+        $entry->save();
+
+        $this->assertArrayNotHasKey('null_value', $entry->model()->data);
+    }
 }

tests/Forms/FormSubmissionTest.php

@@ -101,4 +101,18 @@ public function it_should_not_save_date_in_data()
         $this->assertInstanceOf(Carbon::class, $fresh->date());
         $this->assertSame($fresh->date()->format('u'), $submission->date()->format('u'));
     }
+
+    #[Test]
+    public function null_values_are_removed_from_data()
+    {
+        $form = tap(Facades\Form::make('test')->title('Test'))
+            ->save();
+
+        $submission = tap($form->makeSubmission([
+            'name' => 'John Doe',
+            'null_value' => null,
+        ]))->save();
+
+        $this->assertArrayNotHasKey('null_value', $submission->model()->data);
+    }
 }

tests/Forms/FormTest.php

@@ -71,4 +71,12 @@ public function it_stores_form_data()
 
         $this->assertSame(['some' => 'data'], Arr::get($form->model(), 'settings.data'));
     }
+
+    #[Test]
+    public function null_values_are_removed_from_data()
+    {
+        $form = tap(Facades\Form::make('test')->title('Test form')->data(['some' => 'data', 'null_value' => null]))->save();
+
+        $this->assertSame(['some' => 'data'], Arr::get($form->model(), 'settings.data'));
+    }
 }

tests/Terms/TermTest.php

@@ -30,6 +30,16 @@ public function it_doesnt_create_a_new_model_when_slug_is_changed()
         $this->assertSame('new-slug', TermModel::first()->slug);
     }
 
+    #[Test]
+    public function null_values_are_removed_from_data()
+    {
+        Taxonomy::make('test')->title('test')->save();
+
+        $term = tap(TermFacade::make('test-term')->taxonomy('test')->data(['null_value' => null]))->save();
+
+        $this->assertArrayNotHasKey('null_value', $term->model()->data);
+    }
+
     #[Test]
     public function it_saves_updated_at_value_correctly()
     {