This repository was archived by the owner on Jan 29, 2020. It is now read-only.
- Notifications
You must be signed in to change notification settings - Fork90
Modify middleware listener to use stratigility pipe#217
Merged
weierophinney merged 23 commits intozendframework:developfromasgrim:modify-middleware-listener-to-use-stratigility-pipeMay 1, 2017
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes from15 commits
Commits
Show all changes
23 commits Select commitHold shift + click to select a range
2c64d2e Merge branch 'hotfix/232'
weierophinney2712a99 Require stratigility in dev, and suggestion
asgrimcab17a2 Added tests for handling an array of middleware to be piped
asgrim24201cb Added implementation of Stratigility middleware pipe
asgrimab63639 Updated RotueMatch#getParams calls to be expected in tests
asgrim81c5f2e Extract logic to create middleware pipe into private method
asgrim6f9c271 Do not allow a null middleware
asgrim7e89d6a Remove null coalesce operator because still need to support PHP 5.6
asgrimcebe041 Added support for HttpInterop style middlewares
asgrimd0debca Refactored ReachedFinalHandlerException to use named constructor
asgrim6073ca2 Fixed typo in phpdoc for MvcEvent
asgrimb05cd8b Switch MiddlewareNotCallableExceptionTest assertions to be invoked on…
asgrim7d89900 Fixed incorrectly rebased composer dependencies
asgrim4c393f1 Use namespaced PHPUnit import
asgrim03ffda0 Use expectException instead of deprecated setExpectedException
asgrim4116803 Fixes @return DefaultRenderingStrategy typo at HttpDefaultRenderingSt…
samsonasik4dbdb4b Use mocks instead of anon classes for middlewares
asgrim2a4a644 Merge pull request #237 from samsonasik/@return-rendering-strategy
weierophinney7e5c560 Added CHANGELOG for #237
weierophinney00bdd8c Merge branch 'hotfix/237' into develop
weierophinneybf741df Merge pull request #217 from asgrim/modify-middleware-listener-to-use…
weierophinney6d09019 Rename MiddlewareNotCallableException to InvalidMiddlewareException
weierophinney6a4bf9f Use http-interop process()
weierophinneyFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
6 changes: 4 additions & 2 deletionscomposer.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
108 changes: 107 additions & 1 deletioncomposer.lock
Some generated files are not rendered by default. Learn more abouthow customized files appear on GitHub.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
38 changes: 38 additions & 0 deletionssrc/Exception/MiddlewareNotCallableException.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| <?php | ||
| /** | ||
| * Zend Framework (http://framework.zend.com/) | ||
| * | ||
| * @link http://github.com/zendframework/zf2 for the canonical source repository | ||
| * @copyright Copyright (c) 2005-2017 Zend Technologies USA Inc. (http://www.zend.com) | ||
| * @license http://framework.zend.com/license/new-bsd New BSD License | ||
| */ | ||
| namespaceZend\Mvc\Exception; | ||
| finalclass MiddlewareNotCallableExceptionextends RuntimeException | ||
| ||
| { | ||
| /** | ||
| * @var string | ||
| */ | ||
| private$middlewareName; | ||
| /** | ||
| * @param string $middlewareName | ||
| * @return self | ||
| */ | ||
| publicstaticfunctionfromMiddlewareName($middlewareName) | ||
| { | ||
| $middlewareName = (string)$middlewareName; | ||
| $instance =newself(sprintf('Cannot dispatch middleware %s',$middlewareName)); | ||
| $instance->middlewareName =$middlewareName; | ||
| return$instance; | ||
| } | ||
| /** | ||
| * @return string | ||
| */ | ||
| publicfunctiontoMiddlewareName() | ||
| { | ||
| returnnull !==$this->middlewareName ?$this->middlewareName :''; | ||
| } | ||
| } | ||
21 changes: 21 additions & 0 deletionssrc/Exception/ReachedFinalHandlerException.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| <?php | ||
| /** | ||
| * Zend Framework (http://framework.zend.com/) | ||
| * | ||
| * @link http://github.com/zendframework/zf2 for the canonical source repository | ||
| * @copyright Copyright (c) 2005-2017 Zend Technologies USA Inc. (http://www.zend.com) | ||
| * @license http://framework.zend.com/license/new-bsd New BSD License | ||
| */ | ||
| namespace Zend\Mvc\Exception; | ||
| class ReachedFinalHandlerException extends RuntimeException | ||
| { | ||
| /** | ||
| * @return self | ||
| */ | ||
| public static function create() | ||
| { | ||
| return new self('Reached the final handler for middleware pipe - check the pipe configuration'); | ||
| } | ||
| } |
69 changes: 60 additions & 9 deletionssrc/MiddlewareListener.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -9,12 +9,19 @@ | ||
| namespace Zend\Mvc; | ||
| use Interop\Container\ContainerInterface; | ||
| use Interop\Http\ServerMiddleware\MiddlewareInterface; | ||
| use Psr\Http\Message\ResponseInterface as PsrResponseInterface; | ||
| use Psr\Http\Message\ResponseInterface; | ||
| use Psr\Http\Message\ServerRequestInterface as PsrServerRequestInterface; | ||
| use Zend\EventManager\AbstractListenerAggregate; | ||
| use Zend\EventManager\EventManagerInterface; | ||
| use Zend\Mvc\Exception\MiddlewareNotCallableException; | ||
| use Zend\Mvc\Exception\ReachedFinalHandlerException; | ||
| use Zend\Psr7Bridge\Psr7ServerRequest as Psr7Request; | ||
| use Zend\Psr7Bridge\Psr7Response; | ||
| use Zend\Router\RouteMatch; | ||
| use Zend\Stratigility\MiddlewarePipe; | ||
| class MiddlewareListener extends AbstractListenerAggregate | ||
| { | ||
| @@ -47,15 +54,19 @@ public function onDispatch(MvcEvent $event) | ||
| $application = $event->getApplication(); | ||
| $response = $application->getResponse(); | ||
| $serviceManager = $application->getServiceManager(); | ||
| $psr7ResponsePrototype = Psr7Response::fromZend($response); | ||
| try { | ||
| $pipe = $this->createPipeFromSpec( | ||
| $serviceManager, | ||
| $psr7ResponsePrototype, | ||
| is_array($middleware) ? $middleware : [$middleware] | ||
| ); | ||
| } catch (MiddlewareNotCallableException $middlewareNotCallableException) { | ||
| $return = $this->marshalMiddlewareNotCallable( | ||
| $application::ERROR_MIDDLEWARE_CANNOT_DISPATCH, | ||
| $middlewareNotCallableException->toMiddlewareName(), | ||
| $event, | ||
| $application | ||
| ); | ||
| @@ -69,7 +80,13 @@ public function onDispatch(MvcEvent $event) | ||
| foreach ($routeMatch->getParams() as $key => $value) { | ||
| $psr7Request = $psr7Request->withAttribute($key, $value); | ||
| } | ||
| $return = $pipe( | ||
| ||
| $psr7Request, | ||
| $psr7ResponsePrototype, | ||
| function (PsrServerRequestInterface $request, PsrResponseInterface $response) { | ||
| throw ReachedFinalHandlerException::create(); | ||
| } | ||
| ); | ||
| } catch (\Throwable $ex) { | ||
| $caughtException = $ex; | ||
| } catch (\Exception $ex) { // @TODO clean up once PHP 7 requirement is enforced | ||
| @@ -79,8 +96,6 @@ public function onDispatch(MvcEvent $event) | ||
| if ($caughtException !== null) { | ||
| $event->setName(MvcEvent::EVENT_DISPATCH_ERROR); | ||
| $event->setError($application::ERROR_EXCEPTION); | ||
Member There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Why are these lines removed? ContributorAuthor There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. There is potentially no longer just "one" middleware name... how do we decide which is the failed one? First? Last? IIRC I don't think there's any way (outside of the exception bubble here) Member There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Ah, right - that makes sense, then. | ||
| $event->setParam('exception', $caughtException); | ||
| $events = $application->getEventManager(); | ||
| @@ -100,6 +115,42 @@ public function onDispatch(MvcEvent $event) | ||
| return $response; | ||
| } | ||
| /** | ||
| * Create a middleware pipe from the array spec given. | ||
| * | ||
| * @param ContainerInterface $serviceLocator | ||
| * @param ResponseInterface $responsePrototype | ||
| * @param array $middlewaresToBePiped | ||
| * @return MiddlewarePipe | ||
| * @throws \InvalidArgumentException | ||
| * @throws \Zend\Mvc\Exception\MiddlewareNotCallableException | ||
| */ | ||
| private function createPipeFromSpec( | ||
| ContainerInterface $serviceLocator, | ||
| ResponseInterface $responsePrototype, | ||
| array $middlewaresToBePiped | ||
| ) { | ||
| $pipe = new MiddlewarePipe(); | ||
| $pipe->setResponsePrototype($responsePrototype); | ||
| foreach ($middlewaresToBePiped as $middlewareToBePiped) { | ||
| if (null === $middlewareToBePiped) { | ||
| throw new \InvalidArgumentException('Middleware name cannot be null'); | ||
Member There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. If we rename the exception to | ||
| } | ||
| $middlewareName = is_string($middlewareToBePiped) ? $middlewareToBePiped : get_class($middlewareToBePiped); | ||
| if (is_string($middlewareToBePiped) && $serviceLocator->has($middlewareToBePiped)) { | ||
| $middlewareToBePiped = $serviceLocator->get($middlewareToBePiped); | ||
| } | ||
| if (! $middlewareToBePiped instanceof MiddlewareInterface && ! is_callable($middlewareToBePiped)) { | ||
| throw MiddlewareNotCallableException::fromMiddlewareName($middlewareName); | ||
| } | ||
| $pipe->pipe($middlewareToBePiped); | ||
| } | ||
| return $pipe; | ||
| } | ||
| /** | ||
| * Marshal a middleware not callable exception event | ||
| * | ||
32 changes: 32 additions & 0 deletionstest/Exception/MiddlewareNotCallableExceptionTest.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| <?php | ||
| /** | ||
| * Zend Framework (http://framework.zend.com/) | ||
| * | ||
| * @link http://github.com/zendframework/zf2 for the canonical source repository | ||
| * @copyright Copyright (c) 2005-2017 Zend Technologies USA Inc. (http://www.zend.com) | ||
| * @license http://framework.zend.com/license/new-bsd New BSD License | ||
| */ | ||
| namespace ZendTest\Mvc; | ||
| use PHPUnit\Framework\TestCase; | ||
| use Zend\Mvc\Exception\MiddlewareNotCallableException; | ||
| final class MiddlewareNotCallableExceptionTest extends TestCase | ||
| { | ||
| public function testFromMiddlewareName() | ||
| { | ||
| $middlewareName = uniqid('middlewareName', true); | ||
| $exception = MiddlewareNotCallableException::fromMiddlewareName($middlewareName); | ||
| $this->assertInstanceOf(MiddlewareNotCallableException::class, $exception); | ||
| $this->assertSame('Cannot dispatch middleware ' . $middlewareName, $exception->getMessage()); | ||
| $this->assertSame($middlewareName, $exception->toMiddlewareName()); | ||
| } | ||
| public function testToMiddlewareNameWhenNotSet() | ||
| { | ||
| $exception = new MiddlewareNotCallableException(); | ||
| $this->assertSame('', $exception->toMiddlewareName()); | ||
| } | ||
| } |
27 changes: 27 additions & 0 deletionstest/Exception/ReachedFinalHandlerExceptionTest.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| <?php | ||
| /** | ||
| * Zend Framework (http://framework.zend.com/) | ||
| * | ||
| * @link http://github.com/zendframework/zf2 for the canonical source repository | ||
| * @copyright Copyright (c) 2005-2017 Zend Technologies USA Inc. (http://www.zend.com) | ||
| * @license http://framework.zend.com/license/new-bsd New BSD License | ||
| */ | ||
| namespace ZendTest\Mvc; | ||
| use PHPUnit\Framework\TestCase; | ||
| use Zend\Mvc\Exception\ReachedFinalHandlerException; | ||
| final class ReachedFinalHandlerExceptionTest extends TestCase | ||
| { | ||
| public function testFromNothing() | ||
| { | ||
| $exception = ReachedFinalHandlerException::create(); | ||
| $this->assertInstanceOf(ReachedFinalHandlerException::class, $exception); | ||
| $this->assertSame( | ||
| 'Reached the final handler for middleware pipe - check the pipe configuration', | ||
| $exception->getMessage() | ||
| ); | ||
| } | ||
| } |
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.