task finally (#42)

* task finally

* task finally

* add check type

* add tests

* fix code style

src/EntityFinally.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace kuaukutsu\poc\task;
+
+use kuaukutsu\poc\task\state\TaskStateInterface;
+
+interface EntityFinally
+{
+    /**
+     * @param non-empty-string $uuid Task UUID
+     */
+    public function handle(string $uuid, TaskStateInterface $state): void;
+}

src/TaskDraft.php

@@ -4,6 +4,7 @@
 
 namespace kuaukutsu\poc\task;
 
+use LogicException;
 use kuaukutsu\poc\task\dto\TaskOptions;
 use kuaukutsu\poc\task\state\TaskFlagCommand;
 use kuaukutsu\poc\task\state\TaskStateInterface;
@@ -15,6 +16,11 @@ final class TaskDraft implements EntityTask
 
     private float $timeout = 300.;
 
+    /**
+     * @var class-string<EntityFinally>|null
+     */
+    private ?string $finally = null;
+
     private TaskStateInterface $state;
 
     private readonly EntityUuid $uuid;
@@ -49,6 +55,7 @@ public function getOptions(): TaskOptions
     {
         return new TaskOptions(
             timeout: $this->timeout,
+            finally: $this->finally,
         );
     }
 
@@ -88,4 +95,18 @@ public function setTimeout(float $timeout): self
         $this->timeout = max(1, $timeout);
         return $this;
     }
+
+    /**
+     * @param class-string<EntityFinally> $handler
+     * @throws LogicException not implement the EntityFinally
+     */
+    public function setFinally(string $handler): self
+    {
+        if (is_a($handler, EntityFinally::class, true) === false) {
+            throw new LogicException("[$handler] must implement the EntityFinally.");
+        }
+
+        $this->finally = $handler;
+        return $this;
+    }
 }

src/dto/TaskOptions.php

@@ -5,14 +5,20 @@
 namespace kuaukutsu\poc\task\dto;
 
 use kuaukutsu\poc\task\EntityArrable;
+use kuaukutsu\poc\task\EntityFinally;
 
 /**
  * @readonly
  */
 final class TaskOptions implements EntityArrable
 {
+    /**
+     * @param float $timeout В секундах.
+     * @param class-string<EntityFinally>|null $finally
+     */
     public function __construct(
-        public float $timeout,
+        public readonly float $timeout,
+        public readonly ?string $finally = null,
     ) {
     }
 

src/handler/TaskFinallyHandler.php

@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+
+namespace kuaukutsu\poc\task\handler;
+
+use Throwable;
+use DI\DependencyException;
+use Psr\Container\ContainerExceptionInterface;
+use Psr\Container\NotFoundExceptionInterface;
+use Psr\Container\ContainerInterface;
+use kuaukutsu\poc\task\dto\TaskOptions;
+use kuaukutsu\poc\task\state\TaskStateInterface;
+use kuaukutsu\poc\task\state\TaskStatePrepare;
+use kuaukutsu\poc\task\EntityFinally;
+
+final class TaskFinallyHandler
+{
+    use TaskStatePrepare;
+
+    public function __construct(private readonly ContainerInterface $container)
+    {
+    }
+
+    /**
+     * @param non-empty-string $uuid Task UUID
+     */
+    public function handle(string $uuid, TaskOptions $options, TaskStateInterface $state): void
+    {
+        if ($options->finally === null) {
+            return;
+        }
+
+        try {
+            $this->factory($options->finally)->handle($uuid, $state);
+        } catch (Throwable) {
+        }
+    }
+
+    /**
+     * @throws ContainerExceptionInterface
+     * @throws NotFoundExceptionInterface
+     */
+    private function factory(string $className): EntityFinally
+    {
+        /** @var EntityFinally|object $handler */
+        $handler = $this->container->get($className);
+        if ($handler instanceof EntityFinally) {
+            return $handler;
+        }
+
+        throw new DependencyException("[$className] must implement EntityFinally.");
+    }
+}

src/processing/TaskHandler.php

@@ -11,6 +11,7 @@
 use kuaukutsu\poc\task\handler\StageContextFactory;
 use kuaukutsu\poc\task\handler\StageExecutor;
 use kuaukutsu\poc\task\handler\TaskFactory;
+use kuaukutsu\poc\task\handler\TaskFinallyHandler;
 use kuaukutsu\poc\task\service\StageCommand;
 use kuaukutsu\poc\task\service\StageQuery;
 use kuaukutsu\poc\task\service\TaskExecutor;
@@ -29,6 +30,7 @@ public function __construct(
         private readonly TaskQuery $taskQuery,
         private readonly TaskFactory $taskFactory,
         private readonly TaskExecutor $taskExecutor,
+        private readonly TaskFinallyHandler $finallyHandler,
         private readonly StageQuery $stageQuery,
         private readonly StageCommand $stageCommand,
         private readonly StageContextFactory $contextFactory,
@@ -107,6 +109,12 @@ public function complete(string $taskUuid, string $stageUuid): TaskStateInterfac
             return $stateRelation;
         }
 
+        $this->finallyHandler->handle(
+            $task->getUuid(),
+            $task->getOptions(),
+            $state,
+        );
+
         return $state;
     }
 

tests/TaskBuilderTest.php

@@ -18,6 +18,8 @@
 use kuaukutsu\poc\task\TaskBuilder;
 use kuaukutsu\poc\task\tests\stub\IncreaseNumberStageStub;
 use kuaukutsu\poc\task\tests\stub\TestStageStub;
+use kuaukutsu\poc\task\tests\stub\TestFinally;
+use kuaukutsu\poc\task\tests\stub\TestResponse;
 
 final class TaskBuilderTest extends TestCase
 {
@@ -209,6 +211,38 @@ class: TestStageStub::class,
         $this->builder->build($draftDuplicate);
     }
 
+    public function testCreateFinally(): void
+    {
+        $draft = $this->builder->create(
+            'finaly',
+            new EntityWrapper(
+                class: TestStageStub::class,
+                params: [
+                    'name' => 'Test initialization.',
+                ],
+            ),
+        );
+
+        $draft->setFinally(TestFinally::class);
+        self::assertEquals(TestFinally::class, $draft->getOptions()->finally);
+    }
+
+    public function testCreateFinallyException(): void
+    {
+        $draft = $this->builder->create(
+            'finaly',
+            new EntityWrapper(
+                class: TestStageStub::class,
+                params: [
+                    'name' => 'Test initialization.',
+                ],
+            ),
+        );
+
+        $this->expectException(LogicException::class);
+        $draft->setFinally(TestResponse::class);
+    }
+
     protected function tearDown(): void
     {
         if ($this->task !== null) {