tests for hooks

src/Repository/Fetch/EntityStorage.php

@@ -143,6 +143,12 @@ public function linkEntities(): void
                 }
             }
         }
+
+        // Here, we have all entities linked, we can call afterRetrieve hook
+        foreach ($this->entities as $entity) {
+            $entity->afterRetrieve();
+        }
+
     }
 
     /**

src/Repository/Fetch/ResultService.php

@@ -124,11 +124,6 @@ public function getEntities(string $baseEntityClassString, ?string $propertyName
             }
         }
 
-        foreach ($result as $entity) {
-            $entity->afterRetrieve();
-        }
-
-
         return $result;
     }
 

src/Repository/Saver/Saver.php

@@ -277,13 +277,13 @@ function insert(array $entities): void
             $entity->setPrimaryKeyValue($firstPk);
             $entity->updateRawData();
             $entity->indicateSave();
-            $entity->afterSave();
             $firstPk++;
         }
         //endregion
 
         $this->pdo->commit();
 
+
         foreach ($entities as $entity) {
             $entity->afterSave();
         }

tests/IntegrationTest.php

@@ -37,6 +37,12 @@
 use Tests\Mock\Bugs\DoubleRetrieve\Reward;
 use Tests\Mock\Bugs\TreeSave\RepeatingNode;
 use Tests\Mock\Bugs\TreeSave\TreeSaveRepository;
+use Tests\Mock\EntitiesWithHooks\AfterRetrieveHookEntity;
+use Tests\Mock\EntitiesWithHooks\AfterSaveHookEntity;
+use Tests\Mock\EntitiesWithHooks\BeforeSaveHookEntity;
+use Tests\Mock\EntitiesWithHooks\EntityHookExceptionType;
+use Tests\Mock\EntitiesWithHooks\EntityHookRepository;
+use Tests\Mock\EntitiesWithHooks\EntityWithHookException;
 use Tracy\Debugger;
 use Zrnik\MkSQL\Column;
 use Zrnik\MkSQL\Enum\DriverType;
@@ -198,10 +204,10 @@ function () use ($Updater) {
 
         $this->subTestAllowPrivatePropertiesInEntities($pdo);
 
+        $this->subTestBaseEntityHooks($pdo);
 
         echo ']' . PHP_EOL . 'Complete!';
 
-
     }
 
 
@@ -1207,4 +1213,65 @@ private function subTestAllowPrivatePropertiesInEntities(PDO $pdo): void
         static::assertSame($entities[count($entities) - 1]->id, $entity->id);
 
     }
+
+    private function subTestBaseEntityHooks(PDO $pdo): void
+    {
+        $entityHookRepository = new EntityHookRepository($pdo);
+
+        ###############################################
+        ###############################################
+        ###############################################
+
+        /** @var EntityWithHookException $ex */
+        $ex = $this->assertExceptionThrown(
+            EntityWithHookException::class,
+            function() use ($entityHookRepository) {
+                $entityHookRepository->save(BeforeSaveHookEntity::create());
+            }
+        );
+
+        static::assertSame(
+            EntityHookExceptionType::BEFORE_SAVE,
+            $ex->hookExceptionType
+        );
+
+        ###############################################
+        ###############################################
+        ###############################################
+
+        /** @var EntityWithHookException $ex */
+        $ex = $this->assertExceptionThrown(
+            EntityWithHookException::class,
+            function() use ($entityHookRepository) {
+                $entityHookRepository->save(AfterSaveHookEntity::create());
+            }
+        );
+
+        static::assertSame(
+            EntityHookExceptionType::AFTER_SAVE,
+            $ex->hookExceptionType
+        );
+
+        ###############################################
+        ###############################################
+        ###############################################
+
+        /** @var EntityWithHookException $ex */
+        $ex = $this->assertExceptionThrown(
+            EntityWithHookException::class,
+            function() use ($entityHookRepository) {
+                $entityHookRepository->save(AfterRetrieveHookEntity::create());
+                $entityHookRepository->getAll(
+                    AfterRetrieveHookEntity::class
+                );
+            }
+        );
+
+        static::assertSame(
+            EntityHookExceptionType::AFTER_RETRIEVE,
+            $ex->hookExceptionType
+        );
+
+    }
+
 }

tests/Mock/EntitiesWithHooks/AfterRetrieveHookEntity.php

@@ -0,0 +1,27 @@
+<?php declare(strict_types=1);
+
+namespace Tests\Mock\EntitiesWithHooks;
+
+use Zrnik\MkSQL\Repository\Attributes\ColumnType;
+use Zrnik\MkSQL\Repository\Attributes\PrimaryKey;
+use Zrnik\MkSQL\Repository\Attributes\TableName;
+use Zrnik\MkSQL\Repository\BaseEntity;
+
+#[TableName('hook_test_AfterRetrieveHookEntity')]
+class AfterRetrieveHookEntity extends BaseEntity
+{
+    #[PrimaryKey]
+    public ?int $id = null;
+
+    #[ColumnType('varchar(100)')]
+    public string $afterSaveException = 'Hello World';
+
+    /**
+     * @throws EntityWithHookException
+     * @noinspection PhpMissingParentCallCommonInspection
+     */
+    public function afterRetrieve(): void
+    {
+        throw new EntityWithHookException(EntityHookExceptionType::AFTER_RETRIEVE);
+    }
+}

tests/Mock/EntitiesWithHooks/AfterSaveHookEntity.php

@@ -0,0 +1,27 @@
+<?php declare(strict_types=1);
+
+namespace Tests\Mock\EntitiesWithHooks;
+
+use Zrnik\MkSQL\Repository\Attributes\ColumnType;
+use Zrnik\MkSQL\Repository\Attributes\PrimaryKey;
+use Zrnik\MkSQL\Repository\Attributes\TableName;
+use Zrnik\MkSQL\Repository\BaseEntity;
+
+#[TableName('hook_test_AfterSaveHookEntity')]
+class AfterSaveHookEntity extends BaseEntity
+{
+    #[PrimaryKey]
+    public ?int $id = null;
+
+    #[ColumnType('varchar(100)')]
+    public string $afterSaveException = 'Hello World';
+
+    /**
+     * @throws EntityWithHookException
+     * @noinspection PhpMissingParentCallCommonInspection
+     */
+    public function afterSave(): void
+    {
+        throw new EntityWithHookException(EntityHookExceptionType::AFTER_SAVE);
+    }
+}

tests/Mock/EntitiesWithHooks/BeforeSaveHookEntity.php

@@ -0,0 +1,24 @@
+<?php declare(strict_types=1);
+
+namespace Tests\Mock\EntitiesWithHooks;
+
+use Zrnik\MkSQL\Repository\Attributes\PrimaryKey;
+use Zrnik\MkSQL\Repository\Attributes\TableName;
+use Zrnik\MkSQL\Repository\BaseEntity;
+
+#[TableName('hook_test_BeforeSaveHookEntity')]
+class BeforeSaveHookEntity extends BaseEntity
+{
+    #[PrimaryKey]
+    public ?int $id = null;
+
+    /**
+     * @throws EntityWithHookException
+     * @noinspection PhpMissingParentCallCommonInspection
+     */
+    public function beforeSave(): void
+    {
+        throw new EntityWithHookException(EntityHookExceptionType::BEFORE_SAVE);
+    }
+
+}

tests/Mock/EntitiesWithHooks/EntityHookExceptionType.php

@@ -0,0 +1,13 @@
+<?php declare(strict_types=1);
+
+namespace Tests\Mock\EntitiesWithHooks;
+
+use Zrnik\Base\Enum;
+
+class EntityHookExceptionType extends Enum
+{
+    public const BEFORE_SAVE = 0;
+    public const AFTER_SAVE = 1;
+
+    public const AFTER_RETRIEVE = 10;
+}

tests/Mock/EntitiesWithHooks/EntityHookRepository.php

@@ -0,0 +1,16 @@
+<?php declare(strict_types=1);
+
+namespace Tests\Mock\EntitiesWithHooks;
+
+use Zrnik\MkSQL\Updater;
+use Zrnik\MkSQL\Utilities\Installable;
+
+class EntityHookRepository extends Installable
+{
+    protected function install(Updater $updater): void
+    {
+        $updater->use(AfterRetrieveHookEntity::class);
+        $updater->use(AfterSaveHookEntity::class);
+        $updater->use(BeforeSaveHookEntity::class);
+    }
+}

tests/Mock/EntitiesWithHooks/EntityWithHookException.php

@@ -0,0 +1,22 @@
+<?php declare(strict_types=1);
+
+namespace Tests\Mock\EntitiesWithHooks;
+
+use Exception;
+
+class EntityWithHookException extends Exception
+{
+    public int $hookExceptionType;
+
+    public function __construct(int $hookExceptionType)
+    {
+        $this->hookExceptionType = $hookExceptionType;
+
+        parent::__construct(
+            sprintf(
+                'Hook exception "%s" thrown!',
+                EntityHookExceptionType::getName($hookExceptionType)
+            )
+        );
+    }
+}