From beceef626b49115a7b47ee27740137571fef329f Mon Sep 17 00:00:00 2001 From: Aaron Piotrowski Date: Sun, 30 Jul 2023 13:45:27 -0500 Subject: [PATCH] Rename stack to stackMiddleware --- README.md | 6 +++--- src/Middleware.php | 2 +- src/Middleware/Internal/MiddlewareRequestHandler.php | 2 +- src/Middleware/functions.php | 2 +- src/SocketHttpServer.php | 8 ++++---- test/Middleware/StackTest.php | 6 +++--- 6 files changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 73923641..e8556ef2 100644 --- a/README.md +++ b/README.md @@ -173,10 +173,10 @@ public function handleRequest(Request $request, RequestHandler $next): Response `handleRequest` is the only method of the `Middleware` interface. If the `Middleware` doesn't handle the request itself, it should delegate the response creation to the received `RequestHandler`. ```php -function stack(RequestHandler $handler, Middleware ...$middleware): RequestHandler +function stackMiddleware(RequestHandler $handler, Middleware ...$middleware): RequestHandler ``` -Multiple middlewares can be stacked by using `Amp\Http\Server\Middleware\stack()`, which accepts a `RequestHandler` as first argument and a variable number of `Middleware` instances. The returned `RequestHandler` will invoke each middleware in the provided order. +Multiple middlewares can be stacked by using `Amp\Http\Server\Middleware\stackMiddleware()`, which accepts a `RequestHandler` as first argument and a variable number of `Middleware` instances. The returned `RequestHandler` will invoke each middleware in the provided order. ```php $requestHandler = new class implements RequestHandler { @@ -202,7 +202,7 @@ $middleware = new class implements Middleware { } }; -$stackedHandler = Middleware\stack($requestHandler, $middleware); +$stackedHandler = Middleware\stackMiddleware($requestHandler, $middleware); $errorHandler = new DefaultErrorHandler(); // $logger is a PSR-7 logger instance. diff --git a/src/Middleware.php b/src/Middleware.php index 9d13db9c..765eefdf 100644 --- a/src/Middleware.php +++ b/src/Middleware.php @@ -5,7 +5,7 @@ /** * Middlewares allow pre-processing of requests and post-processing of responses. * - * @see stack() for how to apply a middleware to a request handler. + * @see stackMiddleware() for how to apply a middleware to a request handler. */ interface Middleware { diff --git a/src/Middleware/Internal/MiddlewareRequestHandler.php b/src/Middleware/Internal/MiddlewareRequestHandler.php index 24e9a995..bbce87e6 100644 --- a/src/Middleware/Internal/MiddlewareRequestHandler.php +++ b/src/Middleware/Internal/MiddlewareRequestHandler.php @@ -10,7 +10,7 @@ /** * Wraps a request handler with a single middleware. * - * @see stack() + * @see stackMiddleware() * @internal */ final class MiddlewareRequestHandler implements RequestHandler diff --git a/src/Middleware/functions.php b/src/Middleware/functions.php index 36b81858..82ab350d 100644 --- a/src/Middleware/functions.php +++ b/src/Middleware/functions.php @@ -14,7 +14,7 @@ * * @return RequestHandler Wrapped request handler. */ -function stack(RequestHandler $requestHandler, Middleware ...$middlewares): RequestHandler +function stackMiddleware(RequestHandler $requestHandler, Middleware ...$middlewares): RequestHandler { foreach (\array_reverse($middlewares) as $middleware) { $requestHandler = new MiddlewareRequestHandler($middleware, $requestHandler); diff --git a/src/SocketHttpServer.php b/src/SocketHttpServer.php index 4289bc05..ea6f57ff 100644 --- a/src/SocketHttpServer.php +++ b/src/SocketHttpServer.php @@ -164,8 +164,8 @@ private static function createCompressionMiddleware(PsrLogger $logger): ?Compres } /** - * @param array $middleware Default middlewares. You may also use {@see Middleware\stack()} before - * passing the {@see RequestHandler} to {@see self::start()}. + * @param array $middleware Default middlewares. You may also use {@see Middleware\stackMiddleware()} + * before passing the {@see RequestHandler} to {@see self::start()}. * @param array|null $allowedMethods Use null to disable request method filtering. */ public function __construct( @@ -249,7 +249,7 @@ public function start(RequestHandler $requestHandler, ErrorHandler $errorHandler $this->logger->warning("The 'xdebug' extension is loaded, which has a major impact on performance."); } - $requestHandler = Middleware\stack($requestHandler, ...$this->middleware); + $requestHandler = Middleware\stackMiddleware($requestHandler, ...$this->middleware); if ($this->allowedMethods !== null) { $this->logger->notice(\sprintf( @@ -257,7 +257,7 @@ public function start(RequestHandler $requestHandler, ErrorHandler $errorHandler \implode(', ', $this->allowedMethods), )); - $requestHandler = Middleware\stack( + $requestHandler = Middleware\stackMiddleware( $requestHandler, new AllowedMethodsMiddleware($errorHandler, $this->logger, $this->allowedMethods), ); diff --git a/test/Middleware/StackTest.php b/test/Middleware/StackTest.php index aa64e9da..eb8110b3 100644 --- a/test/Middleware/StackTest.php +++ b/test/Middleware/StackTest.php @@ -11,7 +11,7 @@ use Amp\Http\Server\Response; use Amp\PHPUnit\AsyncTestCase; use League\Uri; -use function Amp\Http\Server\Middleware\stack; +use function Amp\Http\Server\Middleware\stackMiddleware; class StackTest extends AsyncTestCase { @@ -19,7 +19,7 @@ public function testStackAppliesMiddlewaresInCorrectOrder(): void { $request = new Request($this->createMock(Client::class), "GET", Uri\Http::createFromString("/foobar")); - $stack = stack(new ClosureRequestHandler(function (Request $request) { + $stack = stackMiddleware(new ClosureRequestHandler(function (Request $request) { $response = new Response(HttpStatus::OK, [], "OK"); $response->setHeader("stack", $request->getAttribute(StackTest::class)); @@ -45,6 +45,6 @@ public function handleRequest(Request $request, RequestHandler $requestHandler): public function testEmptyMiddlewareSet(): void { $mock = $this->createMock(RequestHandler::class); - self::assertSame($mock, stack($mock)); + self::assertSame($mock, stackMiddleware($mock)); } }