feat: middleware callables (#672)

brendt · web-flow · commit d2e8a4ee5690 · 2024-11-04T08:56:14.000+01:00
diff --git a/src/Tempest/Auth/src/AuthorizerMiddleware.php b/src/Tempest/Auth/src/AuthorizerMiddleware.php
@@ -6,6 +6,7 @@
 
 use Tempest\Container\Container;
 use Tempest\Http\HttpMiddleware;
+use Tempest\Http\HttpMiddlewareCallable;
 use Tempest\Http\MatchedRoute;
 use Tempest\Http\Request;
 use Tempest\Http\Response;
@@ -20,7 +21,7 @@ public function __construct(
     ) {
     }
 
-    public function __invoke(Request $request, callable $next): Response
+    public function __invoke(Request $request, HttpMiddlewareCallable $next): Response
     {
         $attribute = $this->matchedRoute
             ->route
diff --git a/src/Tempest/CommandBus/src/CommandBusMiddleware.php b/src/Tempest/CommandBus/src/CommandBusMiddleware.php
@@ -6,6 +6,5 @@
 
 interface CommandBusMiddleware
 {
-    /** @param callable(object $command): void $next */
-    public function __invoke(object $command, callable $next): void;
+    public function __invoke(object $command, CommandBusMiddlewareCallable $next): void;
 }
diff --git a/src/Tempest/CommandBus/src/CommandBusMiddlewareCallable.php b/src/Tempest/CommandBus/src/CommandBusMiddlewareCallable.php
@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\CommandBus;
+
+use Closure;
+
+final readonly class CommandBusMiddlewareCallable
+{
+    public function __construct(
+        private Closure $closure,
+    ) {
+    }
+
+    public function __invoke(object $command): void
+    {
+        ($this->closure)($command);
+    }
+}
diff --git a/src/Tempest/CommandBus/src/GenericCommandBus.php b/src/Tempest/CommandBus/src/GenericCommandBus.php
@@ -4,7 +4,6 @@
 
 namespace Tempest\CommandBus;
 
-use Closure;
 use Tempest\Container\Container;
 
 final class GenericCommandBus implements CommandBus
@@ -31,21 +30,23 @@ public function dispatch(object $command): void
         $callable($command);
     }
 
-    private function getCallable(CommandHandler $commandHandler): Closure
+    private function getCallable(CommandHandler $commandHandler): CommandBusMiddlewareCallable
     {
-        $callable = function (object $command) use ($commandHandler): void {
+        $callable = new CommandBusMiddlewareCallable(function (object $command) use ($commandHandler): void {
             $commandHandler->handler->invokeArgs(
                 $this->container->get($commandHandler->handler->getDeclaringClass()->getName()),
                 [$command],
             );
 
             $this->history[] = $command;
-        };
+        });
 
         $middlewareStack = $this->commandBusConfig->middleware;
 
         while ($middlewareClass = array_pop($middlewareStack)) {
-            $callable = fn (object $command) => $this->container->get($middlewareClass)($command, $callable);
+            $callable = new CommandBusMiddlewareCallable(
+                fn (object $command) => $this->container->get($middlewareClass)($command, $callable),
+            );
         }
 
         return $callable;
diff --git a/src/Tempest/Console/src/Actions/ExecuteConsoleCommand.php b/src/Tempest/Console/src/Actions/ExecuteConsoleCommand.php
@@ -4,9 +4,9 @@
 
 namespace Tempest\Console\Actions;
 
-use Closure;
 use Tempest\Console\ConsoleConfig;
 use Tempest\Console\ConsoleInputBuilder;
+use Tempest\Console\ConsoleMiddlewareCallable;
 use Tempest\Console\ExitCode;
 use Tempest\Console\Initializers\Invocation;
 use Tempest\Console\Input\ConsoleArgumentBag;
@@ -32,9 +32,9 @@ public function __invoke(string $commandName): ExitCode
         ));
     }
 
-    private function getCallable(array $commandMiddleware): Closure
+    private function getCallable(array $commandMiddleware): ConsoleMiddlewareCallable
     {
-        $callable = function (Invocation $invocation) {
+        $callable = new ConsoleMiddlewareCallable(function (Invocation $invocation) {
             $consoleCommand = $invocation->consoleCommand;
 
             $handler = $consoleCommand->handler;
@@ -49,12 +49,14 @@ private function getCallable(array $commandMiddleware): Closure
             );
 
             return ExitCode::SUCCESS;
-        };
+        });
 
         $middlewareStack = [...$this->consoleConfig->middleware, ...$commandMiddleware];
 
         while ($middlewareClass = array_pop($middlewareStack)) {
-            $callable = fn (Invocation $invocation) => $this->container->get($middlewareClass)($invocation, $callable);
+            $callable = new ConsoleMiddlewareCallable(
+                fn (Invocation $invocation) => $this->container->get($middlewareClass)($invocation, $callable)
+            );
         }
 
         return $callable;
diff --git a/src/Tempest/Console/src/ConsoleMiddleware.php b/src/Tempest/Console/src/ConsoleMiddleware.php
@@ -8,6 +8,5 @@
 
 interface ConsoleMiddleware
 {
-    /** @param callable(Invocation $invocation): ExitCode $next */
-    public function __invoke(Invocation $invocation, callable $next): ExitCode;
+    public function __invoke(Invocation $invocation, ConsoleMiddlewareCallable $next): ExitCode;
 }
diff --git a/src/Tempest/Console/src/ConsoleMiddlewareCallable.php b/src/Tempest/Console/src/ConsoleMiddlewareCallable.php
@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Console;
+
+use Closure;
+use Tempest\Console\Initializers\Invocation;
+
+final readonly class ConsoleMiddlewareCallable
+{
+    public function __construct(
+        private Closure $closure,
+    ) {
+    }
+
+    public function __invoke(Invocation $invocation): ExitCode
+    {
+        return ($this->closure)($invocation);
+    }
+}
diff --git a/src/Tempest/Console/src/Middleware/CautionMiddleware.php b/src/Tempest/Console/src/Middleware/CautionMiddleware.php
@@ -6,6 +6,7 @@
 
 use Tempest\Console\Console;
 use Tempest\Console\ConsoleMiddleware;
+use Tempest\Console\ConsoleMiddlewareCallable;
 use Tempest\Console\ExitCode;
 use Tempest\Console\Initializers\Invocation;
 use Tempest\Core\AppConfig;
@@ -18,7 +19,7 @@ public function __construct(
     ) {
     }
 
-    public function __invoke(Invocation $invocation, callable $next): ExitCode
+    public function __invoke(Invocation $invocation, ConsoleMiddlewareCallable $next): ExitCode
     {
         $environment = $this->appConfig->environment;
 
diff --git a/src/Tempest/Console/src/Middleware/ConsoleExceptionMiddleware.php b/src/Tempest/Console/src/Middleware/ConsoleExceptionMiddleware.php
@@ -6,6 +6,7 @@
 
 use Tempest\Console\Console;
 use Tempest\Console\ConsoleMiddleware;
+use Tempest\Console\ConsoleMiddlewareCallable;
 use Tempest\Console\Exceptions\ConsoleException;
 use Tempest\Console\ExitCode;
 use Tempest\Console\Initializers\Invocation;
@@ -17,7 +18,7 @@ public function __construct(
     ) {
     }
 
-    public function __invoke(Invocation $invocation, callable $next): ExitCode
+    public function __invoke(Invocation $invocation, ConsoleMiddlewareCallable $next): ExitCode
     {
         try {
             return $next($invocation);
diff --git a/src/Tempest/Console/src/Middleware/ForceMiddleware.php b/src/Tempest/Console/src/Middleware/ForceMiddleware.php
@@ -6,6 +6,7 @@
 
 use Tempest\Console\Console;
 use Tempest\Console\ConsoleMiddleware;
+use Tempest\Console\ConsoleMiddlewareCallable;
 use Tempest\Console\ExitCode;
 use Tempest\Console\GenericConsole;
 use Tempest\Console\Initializers\Invocation;
@@ -16,7 +17,7 @@ public function __construct(private Console $console)
     {
     }
 
-    public function __invoke(Invocation $invocation, callable $next): ExitCode
+    public function __invoke(Invocation $invocation, ConsoleMiddlewareCallable $next): ExitCode
     {
         if ($invocation->argumentBag->get('-f') || $invocation->argumentBag->get('force')) {
             if ($this->console instanceof GenericConsole) {
diff --git a/src/Tempest/Console/src/Middleware/HelpMiddleware.php b/src/Tempest/Console/src/Middleware/HelpMiddleware.php
@@ -8,6 +8,7 @@
 use Tempest\Console\Console;
 use Tempest\Console\ConsoleCommand;
 use Tempest\Console\ConsoleMiddleware;
+use Tempest\Console\ConsoleMiddlewareCallable;
 use Tempest\Console\ExitCode;
 use Tempest\Console\Initializers\Invocation;
 
@@ -18,7 +19,7 @@ public function __construct(
     ) {
     }
 
-    public function __invoke(Invocation $invocation, callable $next): ExitCode
+    public function __invoke(Invocation $invocation, ConsoleMiddlewareCallable $next): ExitCode
     {
         if ($invocation->argumentBag->get('-h') || $invocation->argumentBag->get('help')) {
             $this->renderHelp($invocation->consoleCommand);
diff --git a/src/Tempest/Console/src/Middleware/InvalidCommandMiddleware.php b/src/Tempest/Console/src/Middleware/InvalidCommandMiddleware.php
@@ -7,6 +7,7 @@
 use Tempest\Console\Actions\ExecuteConsoleCommand;
 use Tempest\Console\Console;
 use Tempest\Console\ConsoleMiddleware;
+use Tempest\Console\ConsoleMiddlewareCallable;
 use Tempest\Console\Exceptions\InvalidCommandException;
 use Tempest\Console\ExitCode;
 use Tempest\Console\Initializers\Invocation;
@@ -21,7 +22,7 @@ public function __construct(
     ) {
     }
 
-    public function __invoke(Invocation $invocation, callable $next): ExitCode
+    public function __invoke(Invocation $invocation, ConsoleMiddlewareCallable $next): ExitCode
     {
         try {
             return $next($invocation);
diff --git a/src/Tempest/Console/src/Middleware/OverviewMiddleware.php b/src/Tempest/Console/src/Middleware/OverviewMiddleware.php
@@ -8,6 +8,7 @@
 use Tempest\Console\Console;
 use Tempest\Console\ConsoleConfig;
 use Tempest\Console\ConsoleMiddleware;
+use Tempest\Console\ConsoleMiddlewareCallable;
 use Tempest\Console\ExitCode;
 use Tempest\Console\Initializers\Invocation;
 use Tempest\Core\DiscoveryCache;
@@ -21,7 +22,7 @@ public function __construct(
     ) {
     }
 
-    public function __invoke(Invocation $invocation, callable $next): ExitCode
+    public function __invoke(Invocation $invocation, ConsoleMiddlewareCallable $next): ExitCode
     {
         if (! $invocation->argumentBag->getCommandName()) {
             $this->renderOverview(showHidden: $invocation->argumentBag->has('--all', '-a'));
diff --git a/src/Tempest/Console/src/Middleware/ResolveOrRescueMiddleware.php b/src/Tempest/Console/src/Middleware/ResolveOrRescueMiddleware.php
@@ -8,6 +8,7 @@
 use Tempest\Console\Console;
 use Tempest\Console\ConsoleConfig;
 use Tempest\Console\ConsoleMiddleware;
+use Tempest\Console\ConsoleMiddlewareCallable;
 use Tempest\Console\ExitCode;
 use Tempest\Console\Initializers\Invocation;
 
@@ -20,7 +21,7 @@ public function __construct(
     ) {
     }
 
-    public function __invoke(Invocation $invocation, callable $next): ExitCode
+    public function __invoke(Invocation $invocation, ConsoleMiddlewareCallable $next): ExitCode
     {
         $consoleCommand = $this->consoleConfig->commands[$invocation->argumentBag->getCommandName()] ?? null;
 
diff --git a/src/Tempest/EventBus/src/EventBusMiddleware.php b/src/Tempest/EventBus/src/EventBusMiddleware.php
@@ -6,6 +6,5 @@
 
 interface EventBusMiddleware
 {
-    /** @param callable(object $event): void $next */
-    public function __invoke(object $event, callable $next): void;
+    public function __invoke(object $event, EventBusMiddlewareCallable $next): void;
 }
diff --git a/src/Tempest/EventBus/src/EventBusMiddlewareCallable.php b/src/Tempest/EventBus/src/EventBusMiddlewareCallable.php
@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\EventBus;
+
+use Closure;
+
+final readonly class EventBusMiddlewareCallable
+{
+    public function __construct(
+        private Closure $closure,
+    ) {
+    }
+
+    public function __invoke(string|object $event): void
+    {
+        ($this->closure)($event);
+    }
+}
diff --git a/src/Tempest/EventBus/src/GenericEventBus.php b/src/Tempest/EventBus/src/GenericEventBus.php
@@ -24,16 +24,9 @@ public function listen(string|object $event, Closure $handler): void
 
     public function dispatch(string|object $event): void
     {
-
         $eventHandlers = $this->resolveHandlers($event);
 
-        $dispatch = $this->applyMiddleware(function (string|object $event) use ($eventHandlers): void {
-            foreach ($eventHandlers as $eventHandler) {
-                $callable = $eventHandler->normalizeCallable($this->container);
-
-                $callable($event);
-            }
-        });
+        $dispatch = $this->getCallable($eventHandlers);
 
         $dispatch($event);
     }
@@ -64,18 +57,26 @@ private function resolveHandlers(string|object $event): array
         return $handlers;
     }
 
-    private function applyMiddleware(Closure $handler): Closure
+    private function getCallable(array $eventHandlers): EventBusMiddlewareCallable
     {
+        $callable = new EventBusMiddlewareCallable(function (string|object $event) use ($eventHandlers): void {
+            foreach ($eventHandlers as $eventHandler) {
+                $callable = $eventHandler->normalizeCallable($this->container);
+
+                $callable($event);
+            }
+        });
+
         $middlewareStack = $this->eventBusConfig->middleware;
 
         while ($middlewareClass = array_pop($middlewareStack)) {
-            $handler = fn (string|object $event) => $this->container->invoke(
+            $callable = new EventBusMiddlewareCallable(fn (string|object $event) => $this->container->invoke(
                 $middlewareClass,
                 event: $event,
-                next: $handler,
-            );
+                next: $callable,
+            ));
         }
 
-        return $handler;
+        return $callable;
     }
 }
diff --git a/src/Tempest/EventBus/tests/Fixtures/MyEventBusMiddleware.php b/src/Tempest/EventBus/tests/Fixtures/MyEventBusMiddleware.php
@@ -5,12 +5,13 @@
 namespace Tempest\EventBus\Tests\Fixtures;
 
 use Tempest\EventBus\EventBusMiddleware;
+use Tempest\EventBus\EventBusMiddlewareCallable;
 
 final class MyEventBusMiddleware implements EventBusMiddleware
 {
     public static int $hits = 0;
 
-    public function __invoke(object $event, callable $next): void
+    public function __invoke(object $event, EventBusMiddlewareCallable $next): void
     {
         self::$hits += 1;
 
diff --git a/src/Tempest/Http/src/Cookie/SetCookieMiddleware.php b/src/Tempest/Http/src/Cookie/SetCookieMiddleware.php
@@ -5,6 +5,7 @@
 namespace Tempest\Http\Cookie;
 
 use Tempest\Http\HttpMiddleware;
+use Tempest\Http\HttpMiddlewareCallable;
 use Tempest\Http\Request;
 use Tempest\Http\Response;
 
@@ -14,9 +15,8 @@ public function __construct(private CookieManager $cookies)
     {
     }
 
-    public function __invoke(Request $request, callable $next): Response
+    public function __invoke(Request $request, HttpMiddlewareCallable $next): Response
     {
-        /** @var Response $response */
         $response = $next($request);
 
         foreach ($this->cookies->all() as $cookie) {
diff --git a/src/Tempest/Http/src/GenericRouter.php b/src/Tempest/Http/src/GenericRouter.php
diff --git a/src/Tempest/Http/src/HttpMiddleware.php b/src/Tempest/Http/src/HttpMiddleware.php
diff --git a/src/Tempest/Http/src/HttpMiddlewareCallable.php b/src/Tempest/Http/src/HttpMiddlewareCallable.php
diff --git a/tests/Fixtures/Controllers/TestGlobalMiddleware.php b/tests/Fixtures/Controllers/TestGlobalMiddleware.php
diff --git a/tests/Fixtures/Controllers/TestMiddleware.php b/tests/Fixtures/Controllers/TestMiddleware.php
diff --git a/tests/Integration/CommandBus/Fixtures/MyCommandBusMiddleware.php b/tests/Integration/CommandBus/Fixtures/MyCommandBusMiddleware.php
diff --git a/tests/Integration/Console/Fixtures/SpecificMiddleware.php b/tests/Integration/Console/Fixtures/SpecificMiddleware.php

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@`
`6`	`6`
`7`	`7`	`use Tempest\Container\Container;`
`8`	`8`	`use Tempest\Http\HttpMiddleware;`
	`9`	`+use Tempest\Http\HttpMiddlewareCallable;`
`9`	`10`	`use Tempest\Http\MatchedRoute;`
`10`	`11`	`use Tempest\Http\Request;`
`11`	`12`	`use Tempest\Http\Response;`
`@@ -20,7 +21,7 @@ public function __construct(`
`20`	`21`	`) {`
`21`	`22`	`}`
`22`	`23`
`23`		`- public function __invoke(Request $request, callable $next): Response`
	`24`	`+ public function __invoke(Request $request, HttpMiddlewareCallable $next): Response`
`24`	`25`	`{`
`25`	`26`	`$attribute = $this->matchedRoute`
`26`	`27`	`->route`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,5 @@`
`6`	`6`
`7`	`7`	`interface CommandBusMiddleware`
`8`	`8`	`{`
`9`		`- /** @param callable(object $command): void $next */`
`10`		`- public function __invoke(object $command, callable $next): void;`
	`9`	`+ public function __invoke(object $command, CommandBusMiddlewareCallable $next): void;`
`11`	`10`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,5 @@`
`8`	`8`
`9`	`9`	`interface ConsoleMiddleware`
`10`	`10`	`{`
`11`		`- /** @param callable(Invocation $invocation): ExitCode $next */`
`12`		`- public function __invoke(Invocation $invocation, callable $next): ExitCode;`
	`11`	`+ public function __invoke(Invocation $invocation, ConsoleMiddlewareCallable $next): ExitCode;`
`13`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@`
`6`	`6`
`7`	`7`	`use Tempest\Console\Console;`
`8`	`8`	`use Tempest\Console\ConsoleMiddleware;`
	`9`	`+use Tempest\Console\ConsoleMiddlewareCallable;`
`9`	`10`	`use Tempest\Console\ExitCode;`
`10`	`11`	`use Tempest\Console\Initializers\Invocation;`
`11`	`12`	`use Tempest\Core\AppConfig;`
`@@ -18,7 +19,7 @@ public function __construct(`
`18`	`19`	`) {`
`19`	`20`	`}`
`20`	`21`
`21`		`- public function __invoke(Invocation $invocation, callable $next): ExitCode`
	`22`	`+ public function __invoke(Invocation $invocation, ConsoleMiddlewareCallable $next): ExitCode`
`22`	`23`	`{`
`23`	`24`	`$environment = $this->appConfig->environment;`
`24`	`25`