feat: add defer helper (#624)

Author: brendt

src/Tempest/Console/src/ConsoleApplication.php

@@ -54,7 +54,7 @@ public function run(): void
         try {
             $exitCode = ($this->container->get(ExecuteConsoleCommand::class))($this->argumentBag->getCommandName());
 
-            exit($exitCode->value);
+            $this->container->get(Kernel::class)->shutdown($exitCode->value);
         } catch (Throwable $throwable) {
             foreach ($this->appConfig->exceptionHandlers as $exceptionHandler) {
                 $exceptionHandler->handle($throwable);

src/Tempest/Core/src/DeferredTasks.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Core;
+
+use Closure;
+use Tempest\Container\Singleton;
+
+#[Singleton]
+final class DeferredTasks
+{
+    private array $tasks = [];
+
+    public function add(Closure $task): void
+    {
+        $this->tasks[] = $task;
+    }
+
+    public function getTasks(): array
+    {
+        return $this->tasks;
+    }
+}

src/Tempest/Core/src/Kernel.php

@@ -7,6 +7,7 @@
 use Dotenv\Dotenv;
 use Tempest\Container\Container;
 use Tempest\Container\GenericContainer;
+use Tempest\Core\Kernel\FinishDeferredTasks;
 use Tempest\Core\Kernel\LoadConfig;
 use Tempest\Core\Kernel\LoadDiscoveryClasses;
 use Tempest\Core\Kernel\LoadDiscoveryLocations;
@@ -49,6 +50,15 @@ public static function boot(string $root, ?Container $container = null): self
         );
     }
 
+    public function shutdown(int|string $status = ''): never
+    {
+        $this
+            ->finishDeferredTasks()
+            ->event(KernelEvent::SHUTDOWN);
+
+        exit($status);
+    }
+
     private function createContainer(): Container
     {
         $container = new GenericContainer();
@@ -130,6 +140,13 @@ private function loadExceptionHandler(): self
         return $this;
     }
 
+    private function finishDeferredTasks(): self
+    {
+        ($this->container->get(FinishDeferredTasks::class))();
+
+        return $this;
+    }
+
     private function event(object $event): self
     {
         if (interface_exists(EventBus::class)) {

src/Tempest/Core/src/Kernel/FinishDeferredTasks.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Core\Kernel;
+
+use Tempest\Core\DeferredTasks;
+
+final readonly class FinishDeferredTasks
+{
+    public function __construct(
+        private DeferredTasks $deferredTasks,
+    ) {
+    }
+
+    public function __invoke(): void
+    {
+        foreach ($this->deferredTasks->getTasks() as $task) {
+            $task();
+        }
+    }
+}

src/Tempest/Core/src/functions.php

@@ -3,6 +3,10 @@
 declare(strict_types=1);
 
 namespace Tempest {
+
+    use Closure;
+    use Tempest\Core\DeferredTasks;
+
     function path(string ...$parts): string
     {
         $path = implode('/', $parts);
@@ -29,4 +33,9 @@ function env(string $key, mixed $default = null): mixed
             default => $value,
         };
     }
+
+    function defer(Closure $closure): void
+    {
+        get(DeferredTasks::class)->add($closure);
+    }
 }

src/Tempest/Http/src/GenericResponseSender.php

@@ -27,6 +27,10 @@ public function send(Response $response): Response
         $this->sendContent($response);
         ob_end_flush();
 
+        if (function_exists('fastcgi_finish_request')) {
+            fastcgi_finish_request();
+        }
+
         return $response;
     }
 

src/Tempest/Http/src/HttpApplication.php

@@ -56,6 +56,8 @@ public function run(): void
             );
 
             $this->container->get(Session::class)->cleanup();
+
+            $this->container->get(Kernel::class)->shutdown();
         } catch (Throwable $throwable) {
             foreach ($this->container->get(AppConfig::class)->exceptionHandlers as $exceptionHandler) {
                 $exceptionHandler->handle($throwable);

tests/Fixtures/Controllers/DeferController.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Tempest\Fixtures\Controllers;
+
+use function Tempest\defer;
+use Tempest\Http\Get;
+use Tempest\Http\Response;
+use Tempest\Http\Responses\Ok;
+
+final class DeferController
+{
+    public static bool $executed = false;
+
+    #[Get('/defer')]
+    public function __invoke(): Response
+    {
+        defer(function (): void {
+            //            ll('defer start');
+            //            sleep(2);
+            //            ll('defer done');
+            self::$executed = true;
+        });
+
+        return new Ok('ok');
+    }
+}

tests/Integration/Core/DeferredTasksTest.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Tempest\Integration\Core;
+
+use Tempest\Core\Kernel\FinishDeferredTasks;
+use function Tempest\uri;
+use Tests\Tempest\Fixtures\Controllers\DeferController;
+use Tests\Tempest\Integration\FrameworkIntegrationTestCase;
+
+/**
+ * @internal
+ */
+final class DeferredTasksTest extends FrameworkIntegrationTestCase
+{
+    public function test_deferred_tasks_are_executed(): void
+    {
+        DeferController::$executed = false;
+
+        $this->http
+            ->get(uri(DeferController::class))
+            ->assertOk();
+
+        $this->container->get(FinishDeferredTasks::class)();
+
+        $this->assertTrue(DeferController::$executed);
+    }
+}