This repository has been archived by the owner on Jan 29, 2020. It is now read-only.
Allow opt-in to raising exceptions instead of error middleware #78
Conversation
This file contains 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
When enabled, any middleware dispatch is no longer wrapped in try/catch blocks, allowing for exceptions/throwables to bubble out.
Added `$raiseThrowables` property and `raiseThrowables()` method, with the former defaulting to `false` for backwards compatibility. Has the following behavior: - Enables the same flag in the `Dispatch` instance composed. - If enabled and `$err` is passed to `__invoke()`: - Throwable/Exception values are simply thrown. - String arguments are used as the message for a new `MiddlewareException`. - Scalar values are reported in a new `MiddlewareException` - Array value *types* are reported in a new `MiddlewareException` - Object *types* are reported in a new `MiddlewareException` - Non-throwable/exception types trigger the deprecation notice
- Disabled by default - `raiseThrowables()` enables it - When enabled, calls same method on `Next` instance after creating it
weierophinney
added a commit
to weierophinney/zend-stratigility
that referenced
this pull request
Nov 7, 2016
…ndling-v2 Forward-ports zendframework#78 to dev-2.0.0. Conflicts: src/Dispatch.php src/MiddlewarePipe.php src/Next.php test/DispatchTest.php test/NextTest.php
geerteltink
reviewed
Nov 8, 2016
| @@ -28,6 +28,14 @@ | |||
| class Dispatch | |||
There was a problem hiding this comment.
Import Interop\Http\Middleware\DelegateInterface is not used. However it is mentioned as a comment in the docblock right before the process method, but I don't think that's a reason to import it.
There was a problem hiding this comment.
Thanks, removed now.
| @@ -193,6 +212,18 @@ private function dispatchCallableMiddleware( | |||
| break; | |||
| } | |||
|
|
|||
| if ($this->raiseThrowables) { | |||
| if ($hasError && $arity === 4) { | |||
| return $middleware($err, $request, $response, $next); | |||
There was a problem hiding this comment.
This is not tested. Not sure if it's needed though.
There was a problem hiding this comment.
Probably not, as it's the same workflow as what's in the try/catch block... and we're recommending against using error middleware starting in this version anyways.
| return $middleware($request, $response, $next); | ||
| } | ||
|
|
||
| return $next($request, $response, $err); |
There was a problem hiding this comment.
Tests have now been added for both this path, and the one noted above.
Ensure all paths in Dispatch are covered.
weierophinney
added a commit
to weierophinney/zend-stratigility
that referenced
this pull request
Nov 8, 2016
…ndling-v2 Forward port changes made for zendframework#78 (in this case, tests that are no longer applicable). Conflicts: test/DispatchTest.php
weierophinney
added a commit
to weierophinney/zend-stratigility
that referenced
this pull request
Nov 8, 2016
…ndling-v2 Forward port changes from zendframework#78. Conflicts: src/Dispatch.php
weierophinney
added a commit
that referenced
this pull request
Nov 8, 2016
weierophinney
added a commit
that referenced
this pull request
Nov 8, 2016
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This patch implements the features suggested in #77. Specifically, it adds a "raise throwables" flag that may be set on each of the
MiddlewarePipe,Next, andDispatchinstances; setting it on one enables it on each layer deeper:Dispatchonly enables it on that instance.Nextalso enables it onDispatch.MiddlewarePipealso enables it onNextandDispatch.The flag is toggled off by default (current 1.0 behavior), and cannot be disabled once enabled.
Once enabled:
Dispatchwill not wrap middleware dispatch in a try/catch block.Next, when presented with an$errargument will:Zend\Stratigility\Exception\MiddlewareExceptionbased on the$errvalue.MiddlewarePipewill enable the flag onNextinstances it creates (and thus theDispatchinstances).The end result is that, if enabled on the outermost application pipeline, you will now have the 2.0 error handling mechanism in place: middleware raises exceptions, and outer middleware catches these and does something with them.
This feature will allow Expressive, for instance, to opt-in to the feature in the next minor version, while providing default error handling mimicing what it already provides via the
FinalHandlerimplementation, without breaking backwards compatibility.