diff --git a/CHANGELOG.md b/CHANGELOG.md index 9ee40cf..7800259 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,8 @@ ### Unreleased +* [BREAKING]: Handler factory functions now take HandlerFactoryArgs instead of LoggerInterface, this allows us to + also pass the request, to allow for simple routing to different handlers. * [BREAKING]: Added strict types and array shapes throughout. * [BREAKING]: FactoryFunction::call() no longer accepts or passes arguments to the callable. * [Internal] Bump dev dependencies diff --git a/README.md b/README.md index d1addd3..bac3a68 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,9 @@ project alongside code that uses a different framework). ```php new class implements Ingenerator\MicroFramework\RequestHandler { + // your factory function for you to use as required. The HandlerFactoryArgs class also provides the request, + // to allow you to return different handlers based on the request (e.g. for simple routing). + handler_factory: fn(Ingenerator\MicroFramework\HandlerFactoryArgs $args) => new class($args->logger) implements Ingenerator\MicroFramework\RequestHandler { // If you wish to write log entries from your own code, capture the logger as a constructor argument. public function __construct(private readonly $logger) {} - public function handle(\Psr\Http\Message\ServerRequestInterface $request): \Psr\Http\Message\ResponseInterface { + public function handle(ServerRequestInterface $request): \Psr\Http\Message\ResponseInterface { // Do whatever you want with the request here. // Microframework does not provide any routing - if you need to handle different requests with different // code, it is up to you to dispatch them appropriately. diff --git a/src/HandlerFactoryArgs.php b/src/HandlerFactoryArgs.php new file mode 100644 index 0000000..562fd94 --- /dev/null +++ b/src/HandlerFactoryArgs.php @@ -0,0 +1,17 @@ + $handler_factory($logger), RequestHandler::class) + $response = $this + ->createRequestHandler($handler_factory, $logger, $request) ->handle($request); // Render the application result @@ -102,6 +103,19 @@ public function execute( } } + /** + * @param callable(HandlerFactoryArgs $args):RequestHandler $handler_factory + */ + private function createRequestHandler(callable $handler_factory, LoggerInterface $logger, ServerRequestInterface $request): RequestHandler + { + $args = new HandlerFactoryArgs( + logger: $logger, + request: $request + ); + + return FactoryFunction::call(fn () => $handler_factory($args), RequestHandler::class); + } + private function resetOutputBuffersAssertingNoOutput(): void { if (headers_sent($file, $line)) { diff --git a/test/blackbox/BaseBlackboxTestCase.php b/test/blackbox/BaseBlackboxTestCase.php index 28cd4a9..7e3f246 100644 --- a/test/blackbox/BaseBlackboxTestCase.php +++ b/test/blackbox/BaseBlackboxTestCase.php @@ -121,6 +121,7 @@ protected static function provisionDynamicHandlerFactoryWithDefaultBootstrap(str [ <<<'PHP' - fn (LoggerInterface $logger) => new class extends stdClass { + fn () => new class extends stdClass { public function handle(ServerRequestInterface $request): ResponseInterface { return new Response(200, body: 'Should not get here, it is the wrong instance type'); @@ -36,12 +36,12 @@ public function handle(ServerRequestInterface $request): ResponseInterface ]; yield 'factory references undefined class' => [ <<<'PHP' - fn (LoggerInterface $logger) => new \My\Undefined\RequestHandlerClass() + fn () => new \My\Undefined\RequestHandlerClass() PHP, ]; yield 'uncaught exception during handler' => [ <<<'PHP' - fn (LoggerInterface $logger) => new class implements RequestHandler { + fn () => new class implements RequestHandler { public function handle(ServerRequestInterface $request): ResponseInterface { throw new \RuntimeException('You broke it'); @@ -51,7 +51,7 @@ public function handle(ServerRequestInterface $request): ResponseInterface ]; yield 'php error in handler' => [ <<<'PHP' - fn (LoggerInterface $logger) => new class implements RequestHandler { + fn () => new class implements RequestHandler { public function handle(ServerRequestInterface $request): ResponseInterface { $map = ['no' => 'thing']; @@ -62,7 +62,7 @@ public function handle(ServerRequestInterface $request): ResponseInterface ]; yield 'TypeError in handler' => [ <<<'PHP' - fn (LoggerInterface $logger) => new class implements RequestHandler { + fn () => new class implements RequestHandler { public function handle(ServerRequestInterface $request): ResponseInterface { return $this->doThings($request); diff --git a/test/blackbox/HttpHeadersTest.php b/test/blackbox/HttpHeadersTest.php index 1949521..043c002 100644 --- a/test/blackbox/HttpHeadersTest.php +++ b/test/blackbox/HttpHeadersTest.php @@ -17,7 +17,7 @@ public static function setUpBeforeClass(): void parent::setUpBeforeClass(); self::$handler_url = self::provisionDynamicHandlerFactoryWithDefaultBootstrap( <<<'PHP_WRAP' - fn (LoggerInterface $logger) => new class implements RequestHandler { + fn () => new class implements RequestHandler { public function handle(ServerRequestInterface $request): ResponseInterface { $body = \Ingenerator\PHPUtils\StringEncoding\JSON::decodeArray($request->getBody()->getContents()); diff --git a/test/blackbox/HttpResponseCodesTest.php b/test/blackbox/HttpResponseCodesTest.php index 6f1b24b..14c8772 100644 --- a/test/blackbox/HttpResponseCodesTest.php +++ b/test/blackbox/HttpResponseCodesTest.php @@ -15,7 +15,7 @@ public static function setUpBeforeClass(): void parent::setUpBeforeClass(); self::$handler_url = self::provisionDynamicHandlerFactoryWithDefaultBootstrap( <<<'PHP' - fn (LoggerInterface $logger) => new class implements RequestHandler { + fn () => new class implements RequestHandler { public function handle(ServerRequestInterface $request): ResponseInterface { $query = $request->getQueryParams(); @@ -44,7 +44,7 @@ public function testItCanOptionallyUseCustomStatusCodesIfReasonPhraseProvided(): { $handler_url = self::provisionDynamicHandlerFactoryWithDefaultBootstrap( <<<'PHP' - fn (LoggerInterface $logger) => new class implements RequestHandler { + fn () => new class implements RequestHandler { public function handle(ServerRequestInterface $request): ResponseInterface { $query = $request->getQueryParams(); diff --git a/test/blackbox/OutputBufferingTest.php b/test/blackbox/OutputBufferingTest.php index ed10957..0787cab 100644 --- a/test/blackbox/OutputBufferingTest.php +++ b/test/blackbox/OutputBufferingTest.php @@ -50,7 +50,7 @@ public function testItReturnsErrorWithoutOutputIfAnyCodeWritesOutputDuringReques { $handler_url = self::provisionDynamicHandlerFactoryWithDefaultBootstrap( <<<'PHP' - fn (LoggerInterface $logger) => new class implements RequestHandler { + fn () => new class implements RequestHandler { public function handle(ServerRequestInterface $request): ResponseInterface { echo "You did something"; @@ -71,7 +71,7 @@ public function testItTreatsAsErrorIfUserLeavesOutputBuffersOpen(): void { $handler_url = self::provisionDynamicHandlerFactoryWithDefaultBootstrap( <<<'PHP' - fn (LoggerInterface $logger) => new class implements RequestHandler { + fn () => new class implements RequestHandler { public function handle(ServerRequestInterface $request): ResponseInterface { ob_start(); @@ -93,7 +93,7 @@ public function testItTreatsAsErrorIfUserFlushesOutputBuffers(): void { $handler_url = self::provisionDynamicHandlerFactoryWithDefaultBootstrap( <<<'PHP' - fn (LoggerInterface $logger) => new class implements RequestHandler { + fn () => new class implements RequestHandler { public function handle(ServerRequestInterface $request): ResponseInterface { ob_start(); @@ -116,7 +116,7 @@ public function testItDoesNotTreatAsErrorIfUserHandlesOutputBufferingCorrectly() { $handler_url = self::provisionDynamicHandlerFactoryWithDefaultBootstrap( <<<'PHP' - fn (LoggerInterface $logger) => new class implements RequestHandler { + fn () => new class implements RequestHandler { public function handle(ServerRequestInterface $request): ResponseInterface { ob_start(); @@ -138,7 +138,7 @@ public function testItDoesNotTreatAsErrorIfUserHandlesOutputBufferingCorrectlyWi { $handler_url = self::provisionDynamicHandlerFactoryWithDefaultBootstrap( <<<'PHP' - fn (LoggerInterface $logger) => new class implements RequestHandler { + fn () => new class implements RequestHandler { public function handle(ServerRequestInterface $request): ResponseInterface { ob_start(); diff --git a/test/blackbox/RequestParsingTest.php b/test/blackbox/RequestParsingTest.php index b409132..f801c86 100644 --- a/test/blackbox/RequestParsingTest.php +++ b/test/blackbox/RequestParsingTest.php @@ -19,7 +19,7 @@ public static function setUpBeforeClass(): void parent::setUpBeforeClass(); self::$handler_url = self::provisionDynamicHandlerFactoryWithDefaultBootstrap( <<<'PHP' - fn (LoggerInterface $logger) => new class implements RequestHandler { + fn () => new class implements RequestHandler { public function handle(ServerRequestInterface $request): ResponseInterface { return new Response( @@ -186,7 +186,7 @@ public function testItCanDetectIncomingUrlsWhenRewriting(): void { $handler_url = self::provisionDynamicHandlerFactoryWithDefaultBootstrap( <<<'PHP' - fn (LoggerInterface $logger) => new class implements RequestHandler { + fn () => new class implements RequestHandler { public function handle(ServerRequestInterface $request): ResponseInterface { return new Response( diff --git a/test/blackbox/StackdriverLoggingTest.php b/test/blackbox/StackdriverLoggingTest.php index f207143..29898aa 100644 --- a/test/blackbox/StackdriverLoggingTest.php +++ b/test/blackbox/StackdriverLoggingTest.php @@ -23,7 +23,6 @@ public function testItLogsRequestsOnCompletionInStackdriverFormat(): void use Ingenerator\MicroFramework\RequestHandler; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; - use Psr\Log\LoggerInterface; require_once('/var/www/vendor/autoload.php'); @@ -37,7 +36,7 @@ public function testItLogsRequestsOnCompletionInStackdriverFormat(): void service_name: 'my-service', version_file_path: $version_file_path, ), - handler_factory: fn (LoggerInterface $logger) => new class implements RequestHandler { + handler_factory: fn () => new class implements RequestHandler { public function handle(ServerRequestInterface $request): ResponseInterface { return new Response(203, body: 'OK'); @@ -113,7 +112,6 @@ public function testItLogsUncaughtExceptionsAndRequestInStackdriverFormat(): voi use Ingenerator\MicroFramework\RequestHandler; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; - use Psr\Log\LoggerInterface; require_once('/var/www/vendor/autoload.php'); // Note: defining this as a named class to make log output assertions easier to follow (anonymous classes @@ -131,7 +129,7 @@ public function handle(ServerRequestInterface $request): ResponseInterface service_name: 'my-service', version_file_path: '/var/www/version.php', ), - handler_factory: fn (LoggerInterface $logger) => new MyHandler($logger), + handler_factory: fn () => new MyHandler(), ); PHP, ); @@ -184,7 +182,7 @@ public function handle(ServerRequestInterface $request): ResponseInterface $this->assertSame( [ 'severity' => 'EMERGENCY', - 'message' => 'Uncaught RuntimeException: I broke at /var/www/htdocs/dynamic/StackdriverLoggingTest_54a57cd69e4889f9c6cfdde12f4607f1461dec3e/index.php:/var/www/htdocs/dynamic/StackdriverLoggingTest_54a57cd69e4889f9c6cfdde12f4607f1461dec3e/index.php', + 'message' => 'Uncaught RuntimeException: I broke at /var/www/htdocs/dynamic/StackdriverLoggingTest_2e73de2f8da6828bd4b6026ac94ec76b0432a401/index.php:/var/www/htdocs/dynamic/StackdriverLoggingTest_2e73de2f8da6828bd4b6026ac94ec76b0432a401/index.php', '@ingenType' => 'app', 'serviceContext' => [ 'service' => 'my-service', @@ -199,7 +197,7 @@ public function handle(ServerRequestInterface $request): ResponseInterface ], 'reportLocation' => [ 'filePath' => '/var/www/vendor/ingenerator/microframework/src/MicroFramework.php', - 'lineNumber' => 152, + 'lineNumber' => 166, 'functionName' => 'Ingenerator\MicroFramework\MicroFramework->logUncaughtException', ], ], @@ -208,25 +206,25 @@ public function handle(ServerRequestInterface $request): ResponseInterface 'class' => 'RuntimeException', 'msg' => 'I broke', 'code' => 0, - 'file' => '/var/www/htdocs/dynamic/StackdriverLoggingTest_54a57cd69e4889f9c6cfdde12f4607f1461dec3e/index.php', - 'line' => 17, + 'file' => '/var/www/htdocs/dynamic/StackdriverLoggingTest_2e73de2f8da6828bd4b6026ac94ec76b0432a401/index.php', + 'line' => 16, 'trace' => <<<'TEXT' - #0 /var/www/vendor/ingenerator/microframework/src/MicroFramework.php(81): MyHandler->handle() - #1 /var/www/htdocs/dynamic/StackdriverLoggingTest_54a57cd69e4889f9c6cfdde12f4607f1461dec3e/index.php(21): Ingenerator\MicroFramework\MicroFramework->execute() + #0 /var/www/vendor/ingenerator/microframework/src/MicroFramework.php(82): MyHandler->handle() + #1 /var/www/htdocs/dynamic/StackdriverLoggingTest_2e73de2f8da6828bd4b6026ac94ec76b0432a401/index.php(20): Ingenerator\MicroFramework\MicroFramework->execute() #2 {main} TEXT, ], 'logging.googleapis.com/sourceLocation' => [ 'file' => '/var/www/vendor/ingenerator/microframework/src/MicroFramework.php', - 'line' => 152, + 'line' => 166, 'function' => 'Ingenerator\MicroFramework\MicroFramework->logUncaughtException', ], '@type' => 'type.googleapis.com/google.devtools.clouderrorreporting.v1beta1.ReportedErrorEvent', 'stack_trace' => <<<'TEXT' - PHP Warning: RuntimeException: I broke in /var/www/htdocs/dynamic/StackdriverLoggingTest_54a57cd69e4889f9c6cfdde12f4607f1461dec3e/index.php:17 + PHP Warning: RuntimeException: I broke in /var/www/htdocs/dynamic/StackdriverLoggingTest_2e73de2f8da6828bd4b6026ac94ec76b0432a401/index.php:16 Stack trace: - #0 /var/www/vendor/ingenerator/microframework/src/MicroFramework.php(81): MyHandler->handle() - #1 /var/www/htdocs/dynamic/StackdriverLoggingTest_54a57cd69e4889f9c6cfdde12f4607f1461dec3e/index.php(21): Ingenerator\MicroFramework\MicroFramework->execute() + #0 /var/www/vendor/ingenerator/microframework/src/MicroFramework.php(82): MyHandler->handle() + #1 /var/www/htdocs/dynamic/StackdriverLoggingTest_2e73de2f8da6828bd4b6026ac94ec76b0432a401/index.php(20): Ingenerator\MicroFramework\MicroFramework->execute() #2 {main} TEXT, ], @@ -266,6 +264,7 @@ public function testItOutputsCustomAppLogsInStackdriverFormat(): void new MyHandler($logger), + handler_factory: fn (HandlerFactoryArgs $args) => new MyHandler($args->logger), ); PHP, ); @@ -360,8 +359,8 @@ public function handle(ServerRequestInterface $request): ResponseInterface ], // 'logging.googleapis.com/trace' => '66991537308e16.07573263', 'logging.googleapis.com/sourceLocation' => [ - 'file' => '/var/www/htdocs/dynamic/StackdriverLoggingTest_0ba32a129fbc45c0d394a95f76d7bdf405c84692/index.php', - 'line' => 18, + 'file' => '/var/www/htdocs/dynamic/StackdriverLoggingTest_b6ab65fbb5280907f86e2517cfa96312e743341d/index.php', + 'line' => 19, 'function' => 'MyHandler->handle', ], 'custom_context' => [ diff --git a/test/blackbox/VariableRequestHandlerTest.php b/test/blackbox/VariableRequestHandlerTest.php new file mode 100644 index 0000000..83fbdf9 --- /dev/null +++ b/test/blackbox/VariableRequestHandlerTest.php @@ -0,0 +1,42 @@ + match ($args->request->getMethod()) { + 'POST' => new class implements RequestHandler { + public function handle(ServerRequestInterface $request): ResponseInterface + { + return new Response(201, body: 'You made a new thing'); + } + }, + 'GET' => new class implements RequestHandler { + public function handle(ServerRequestInterface $request): ResponseInterface + { + return new Response(200, body: 'You got a thing'); + } + } + } + PHP, + ); + } + + #[TestWith(['POST', 201, 'You made a new thing'])] + #[TestWith(['GET', 200, 'You got a thing'])] + public function testItPassesRequestToHandlerFactoryForRouting(string $method, int $expectedStatus, string $expectedBody): void + { + $this->assertResponseMatches($expectedStatus, $expectedBody, $this->guzzle->request($method, self::$handler_url)); + } +}