Log an exception if SharpForm::update() does not return the instance id on creation

Author: dvlpp

src/EntityList/Commands/QuickCreate/QuickCreationCommand.php

@@ -3,6 +3,7 @@
 namespace Code16\Sharp\EntityList\Commands\QuickCreate;
 
 use Code16\Sharp\EntityList\Commands\EntityCommand;
+use Code16\Sharp\Exceptions\Form\SharpFormUpdateException;
 use Code16\Sharp\Form\Fields\SharpFormField;
 use Code16\Sharp\Form\SharpForm;
 use Code16\Sharp\Utils\Fields\FieldsContainer;
@@ -73,6 +74,11 @@ public function getInstanceId(): mixed
     public function execute(array $data = []): array
     {
         $this->instanceId = $this->sharpForm->update(null, $data);
+
+        if ($this->instanceId === null) {
+            report(new SharpFormUpdateException('The update() method in '.get_class($this->sharpForm).' must return the newly created instance id'));
+        }
+
         $currentUrl = sharp()->context()->breadcrumb()->getCurrentSegmentUrl();
 
         return $this->sharpForm->isDisplayShowPageAfterCreation()

src/Http/Controllers/FormController.php

@@ -5,6 +5,7 @@
 use Code16\Sharp\Auth\SharpAuthorizationManager;
 use Code16\Sharp\Data\BreadcrumbData;
 use Code16\Sharp\Data\Form\FormData;
+use Code16\Sharp\Exceptions\Form\SharpFormUpdateException;
 use Code16\Sharp\Form\SharpForm;
 use Code16\Sharp\Form\SharpSingleForm;
 use Code16\Sharp\Utils\Entities\SharpEntityManager;
@@ -145,6 +146,11 @@ public function store(string $parentUri, EntityKey $entityKey)
 
         $formattedData = $form->formatAndValidateRequestData(request()->all());
         $instanceId = $form->update(null, $formattedData);
+
+        if ($instanceId === null) {
+            report(new SharpFormUpdateException('The update() method in '.get_class($form).' must return the newly created instance id'));
+        }
+
         $this->uploadManager->dispatchJobs($instanceId);
 
         $previousUrl = sharp()->context()->breadcrumb()->getPreviousSegmentUrl();

tests/Http/Api/Commands/ApiEntityListQuickCreationCommandControllerTest.php

@@ -1,10 +1,12 @@
 <?php
 
+use Code16\Sharp\Exceptions\Form\SharpFormUpdateException;
 use Code16\Sharp\Form\Fields\SharpFormTextField;
 use Code16\Sharp\Tests\Fixtures\Entities\PersonEntity;
 use Code16\Sharp\Tests\Fixtures\Sharp\PersonForm;
 use Code16\Sharp\Tests\Fixtures\Sharp\PersonList;
 use Code16\Sharp\Utils\Fields\FieldsContainer;
+use Illuminate\Support\Facades\Exceptions;
 
 beforeEach(function () {
     sharp()->config()->addEntity('person', PersonEntity::class);
@@ -122,6 +124,33 @@ public function update($id, array $data)
         ->assertJson(['action' => 'reload']);
 });
 
+it('logs an error if the form’s update() method does not return the instance id', function () {
+    Exceptions::fake();
+
+    fakeListFor('person', new class() extends PersonList
+    {
+        public function buildListConfig(): void
+        {
+            $this->configureQuickCreationForm();
+        }
+    });
+
+    fakeFormFor('person', new class() extends PersonForm
+    {
+        public function update($id, array $data) {}
+    });
+
+    $this
+        ->postJson(
+            route('code16.sharp.api.list.command.quick-creation-form.create', ['person']),
+            ['data' => []],
+        )
+        ->assertOk()
+        ->assertJson(['action' => 'reload']);
+
+    Exceptions::assertReported(SharpFormUpdateException::class);
+});
+
 it('validates posted data of a quick creation command', function () {
     fakeListFor('person', new class() extends PersonList
     {

tests/Http/Form/FormControllerTest.php

@@ -2,6 +2,7 @@
 
 use Code16\Sharp\Enums\PageAlertLevel;
 use Code16\Sharp\Exceptions\Form\SharpApplicativeException;
+use Code16\Sharp\Exceptions\Form\SharpFormUpdateException;
 use Code16\Sharp\Form\Fields\SharpFormCheckField;
 use Code16\Sharp\Form\Fields\SharpFormEditorField;
 use Code16\Sharp\Form\Fields\SharpFormTextField;
@@ -14,6 +15,7 @@
 use Code16\Sharp\Utils\Entities\SharpEntityManager;
 use Code16\Sharp\Utils\Fields\FieldsContainer;
 use Code16\Sharp\Utils\PageAlerts\PageAlert;
+use Illuminate\Support\Facades\Exceptions;
 use Inertia\Testing\AssertableInertia as Assert;
 
 beforeEach(function () {
@@ -189,6 +191,22 @@ public function buildFormConfig(): void
         ->assertRedirect('/sharp/s-list/person/s-show/person/1');
 });
 
+it('logs an error if the update() method does not return the instance id', function () {
+    Exceptions::fake();
+
+    fakeFormFor('person', new class() extends PersonForm
+    {
+        public function update(mixed $id, array $data) {}
+    });
+
+    $this
+        ->post('/sharp/s-list/person/s-form/person')
+        ->assertRedirect()
+        ->assertSessionDoesntHaveErrors();
+
+    Exceptions::assertReported(SharpFormUpdateException::class);
+});
+
 it('validates an instance before store and update with the rules() method', function () {
     fakeFormFor('person', new class() extends PersonForm
     {