feat(database): model validation before update, create, and save (#1131)

Author: brendt

src/Tempest/Database/src/Builder/ModelInspector.php

@@ -6,6 +6,9 @@
 use Tempest\Database\Config\DatabaseConfig;
 use Tempest\Database\Table;
 use Tempest\Reflection\ClassReflector;
+use Tempest\Validation\Exceptions\ValidationException;
+use Tempest\Validation\SkipValidation;
+use Tempest\Validation\Validator;
 
 use function Tempest\get;
 
@@ -62,6 +65,10 @@ public function getPropertyValues(): array
         $values = [];
 
         foreach ($this->modelClass->getProperties() as $property) {
+            if (! $property->isInitialized($this->model)) {
+                continue;
+            }
+
             if ($property->getIterableType()?->isRelation()) {
                 continue;
             }
@@ -73,4 +80,35 @@ public function getPropertyValues(): array
 
         return $values;
     }
+
+    public function validate(mixed ...$data): void
+    {
+        if (! $this->isObjectModel()) {
+            return;
+        }
+
+        $validator = new Validator();
+        $failingRules = [];
+
+        foreach ($data as $key => $value) {
+            $property = $this->modelClass->getProperty($key);
+
+            if ($property->hasAttribute(SkipValidation::class)) {
+                continue;
+            }
+
+            $failingRulesForProperty = $validator->validateValueForProperty(
+                $property,
+                $value,
+            );
+
+            if ($failingRulesForProperty !== []) {
+                $failingRules[$key] = $failingRulesForProperty;
+            }
+        }
+
+        if ($failingRules !== []) {
+            throw new ValidationException($this->modelClass->getName(), $failingRules);
+        }
+    }
 }

src/Tempest/Database/src/IsDatabaseModel.php

@@ -62,10 +62,19 @@ public static function find(mixed ...$conditions): SelectQueryBuilder
 
     public static function create(mixed ...$params): self
     {
-        return self::new(...$params)->save();
+        model(self::class)->validate(...$params);
+
+        $model = self::new(...$params);
+
+        $model->id = query(self::class)
+            ->insert($model)
+            ->build()
+            ->execute();
+
+        return $model;
     }
 
-    public static function updateOrNew(array $find, array $update): self
+    public static function findOrNew(array $find, array $update): self
     {
         $existing = self::select()->bind(...$find);
 
@@ -84,7 +93,13 @@ public static function updateOrNew(array $find, array $update): self
 
     public static function updateOrCreate(array $find, array $update): self
     {
-        return self::updateOrNew($find, $update)->save();
+        $model = self::findOrNew($find, $update);
+
+        if (! isset($model->id)) {
+            return self::create(...$update);
+        }
+
+        return $model->save();
     }
 
     public function __get(string $name): mixed
@@ -123,6 +138,10 @@ public function load(string ...$relations): self
 
     public function save(): self
     {
+        $model = model($this);
+
+        $model->validate(...model($this)->getPropertyValues());
+
         if (! isset($this->id)) {
             $query = query($this::class)->insert($this);
 
@@ -138,6 +157,8 @@ public function save(): self
 
     public function update(mixed ...$params): self
     {
+        model(self::class)->validate(...$params);
+
         foreach ($params as $key => $value) {
             $this->{$key} = $value;
         }

src/Tempest/Router/src/GenericRouter.php

@@ -80,7 +80,7 @@ private function processRequest(Request|PsrRequest $request): Response
             } catch (NotFoundException) {
                 return new NotFound();
             } catch (ValidationException $validationException) {
-                return new Invalid($validationException->object, $validationException->failingRules);
+                return new Invalid($validationException->subject, $validationException->failingRules);
             }
         } else {
             $request = $this->resolveRequest($request, $matchedRoute);

src/Tempest/Validation/src/Exceptions/ValidationException.php

@@ -12,7 +12,7 @@
 final class ValidationException extends Exception
 {
     public function __construct(
-        public readonly object $object,
+        public readonly object|string $subject,
         public readonly array $failingRules,
     ) {
         $messages = [];
@@ -24,6 +24,10 @@ public function __construct(
             }
         }
 
-        parent::__construct($object::class . PHP_EOL . json_encode($messages, JSON_PRETTY_PRINT));
+        if (is_object($subject)) {
+            $subject = $subject::class;
+        }
+
+        parent::__construct($subject . PHP_EOL . json_encode($messages, JSON_PRETTY_PRINT));
     }
 }

tests/Integration/ORM/IsDatabaseModelTest.php

@@ -13,6 +13,7 @@
 use Tempest\Database\Migrations\CreateMigrationsTable;
 use Tempest\Mapper\CasterFactory;
 use Tempest\Mapper\SerializerFactory;
+use Tempest\Validation\Exceptions\ValidationException;
 use Tests\Tempest\Fixtures\Migrations\CreateAuthorTable;
 use Tests\Tempest\Fixtures\Migrations\CreateBookTable;
 use Tests\Tempest\Fixtures\Models\A;
@@ -42,10 +43,12 @@
 use Tests\Tempest\Integration\ORM\Models\CasterEnum;
 use Tests\Tempest\Integration\ORM\Models\CasterModel;
 use Tests\Tempest\Integration\ORM\Models\ChildModel;
+use Tests\Tempest\Integration\ORM\Models\ModelWithValidation;
 use Tests\Tempest\Integration\ORM\Models\ParentModel;
 use Tests\Tempest\Integration\ORM\Models\StaticMethodTableNameModel;
 use Tests\Tempest\Integration\ORM\Models\ThroughModel;
 
+use function Tempest\Database\model;
 use function Tempest\map;
 
 /**
@@ -540,4 +543,54 @@ public function test_table_name_overrides(): void
         $this->assertEquals('custom_attribute_table_name', new ModelDefinition(AttributeTableNameModel::class)->getTableDefinition()->name);
         $this->assertEquals('custom_static_method_table_name', new ModelDefinition(StaticMethodTableNameModel::class)->getTableDefinition()->name);
     }
+
+    public function test_validation_on_create(): void
+    {
+        $this->expectException(ValidationException::class);
+
+        ModelWithValidation::create(
+            index: -1,
+        );
+    }
+
+    public function test_validation_on_update(): void
+    {
+        $model = ModelWithValidation::new(
+            id: new Id(1),
+            index: 1,
+        );
+
+        $this->expectException(ValidationException::class);
+
+        $model->update(
+            index: -1,
+        );
+    }
+
+    public function test_validation_on_new(): void
+    {
+        $model = ModelWithValidation::new(
+            index: 1,
+        );
+
+        $model->index = -1;
+
+        $this->expectException(ValidationException::class);
+
+        $model->save();
+    }
+
+    public function test_skipped_validation(): void
+    {
+        try {
+            model(ModelWithValidation::class)->validate(
+                index: -1,
+                skip: -1,
+            );
+        } catch (ValidationException $validationException) {
+            $this->assertStringContainsString('index', $validationException->getMessage());
+            $this->assertStringContainsString(ModelWithValidation::class, $validationException->getMessage());
+            $this->assertStringNotContainsString('skip', $validationException->getMessage());
+        }
+    }
 }

tests/Integration/ORM/Models/ModelWithValidation.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Tests\Tempest\Integration\ORM\Models;
+
+use Tempest\Database\IsDatabaseModel;
+use Tempest\Validation\Rules\Between;
+use Tempest\Validation\SkipValidation;
+
+final class ModelWithValidation
+{
+    use IsDatabaseModel;
+
+    #[Between(min: 1, max: 10)]
+    public int $index;
+
+    #[SkipValidation]
+    public int $skip;
+}