Improve error reporting in router panel of web profiler #17744
Closed
Conversation
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
|
Tests are falling now. Status: Needs work |
|
I've fixed tests and I've added a test for the new error message. |
|
LGTM |
|
@javiereguiluz I've investigated this problem too and I found a way to display the traces instead of display an exception message: +use Symfony\Component\HttpFoundation\Request;
class TraceableUrlMatcher extends UrlMatcher
{
//...
+ public function getTracesRequest(Request $request)
+ {
+ $this->request = $request;
+
+ $ret = $this->getTraces($request->getPathInfo());
+
+ $this->request = null;
+
+ return $ret;
+ }
}And use Symfony\Component\HttpFoundation\Request;
class RouterController
{
//...
public function panelAction($token)
{
//...
+ /** @var RequestDataCollector $request */
$request = $profile->getCollector('request');
+ $traceRequest = Request::create(
+ $request->getPathInfo(),
+ $request->getRequestServer()->get('REQUEST_METHOD'),
+ $request->getRequestAttributes()->all(),
+ $request->getRequestCookies()->all(),
+ [],
+ $request->getRequestServer()->all()
+ );
return new Response($this->twig->render('@WebProfiler/Router/panel.html.twig', array(
'request' => $request,
'router' => $profile->getCollector('router'),
- 'traces' => $matcher->getTraces($request->getPathInfo()),
+ 'traces' => $matcher->getTracesRequest($traceRequest),
)), 200, array('Content-Type' => 'text/html'));
}
}WDYT? |
|
|
||
| $matchingRequest = Request::create('/foo', 'GET', array(), array(), array(), array('HTTP_USER_AGENT' => 'Firefox')); | ||
| $traces = $matcher->getTracesFromRequest($matchingRequest); | ||
| $this->assertEquals("Route matches!", $traces[0]['log']); |
There was a problem hiding this comment.
fabbot suggest to use single quote here.
|
AppVeyor build faild (no related) |
| @@ -40,6 +41,15 @@ public function getTraces($pathinfo) | |||
| return $this->traces; | |||
| } | |||
|
|
|||
| public function getTracesFromRequest(Request $request) | |||
There was a problem hiding this comment.
getTraces*For*Request I think this is the pattern we are using elsewhere.
|
LGTM |
|
Thank you @javiereguiluz. |
fabpot
added a commit
that referenced
this pull request
Mar 3, 2016
…aviereguiluz) This PR was squashed before being merged into the 2.7 branch (closes #17744). Discussion ---------- Improve error reporting in router panel of web profiler | Q | A | ------------- | --- | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #17342 | License | MIT | Doc PR | - ### Problem If you define a route condition like this: ```yaml app: resource: '@AppBundle/Controller/' type: annotation condition: "request.server.get('HTTP_HOST') matches '/.*\.dev/'" ``` When browsing the Routing panel in the web profiler, you see an exception:  #### Why? Because the route condition uses the `request` object, but the special `TraceableUrlMatcher` class doesn't get access to the real `request` object but to the special object obtained via: ```php $request = $profile->getCollector('request'); ``` These are the contents of this pseudo-request:  `request.server.get(...)` condition fails because `request.server` is `null`. The full exception message shows this:  ### Solution I propose to catch all exceptions in `TraceableUrlMatcher` and display an error message with some details of the exception:  Commits ------- 1001554 Improve error reporting in router panel of web profiler
|
@javiereguiluz not passing a Request object when evaluating the condition should be considered as a bug IMO. Assuming that the collector has a compatible-enough API is not fine. |
|
sorry, just saw that it was indeed done properly in the final diff. I commented too fast |
Merged
|
Attempted to load class "Request" from namespace "Symfony\Bundle\WebProfilerBundle\Controller". In vendor/symfony/symfony/src/Symfony/Bundle/WebProfilerBundle/Controller/RouterController.php Missing "use" statement? |
Merged
ostrolucky
pushed a commit
to ostrolucky/symfony
that referenced
this pull request
Mar 25, 2018
…iler (javiereguiluz) This PR was squashed before being merged into the 2.7 branch (closes symfony#17744). Discussion ---------- Improve error reporting in router panel of web profiler | Q | A | ------------- | --- | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | symfony#17342 | License | MIT | Doc PR | - ### Problem If you define a route condition like this: ```yaml app: resource: '@AppBundle/Controller/' type: annotation condition: "request.server.get('HTTP_HOST') matches '/.*\.dev/'" ``` When browsing the Routing panel in the web profiler, you see an exception:  #### Why? Because the route condition uses the `request` object, but the special `TraceableUrlMatcher` class doesn't get access to the real `request` object but to the special object obtained via: ```php $request = $profile->getCollector('request'); ``` These are the contents of this pseudo-request:  `request.server.get(...)` condition fails because `request.server` is `null`. The full exception message shows this:  ### Solution I propose to catch all exceptions in `TraceableUrlMatcher` and display an error message with some details of the exception:  Commits ------- 1001554 Improve error reporting in router panel of web profiler
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Problem
If you define a route condition like this:
When browsing the Routing panel in the web profiler, you see an exception:
Why?
Because the route condition uses the
requestobject, but the specialTraceableUrlMatcherclass doesn't get access to the realrequestobject but to the special object obtained via:These are the contents of this pseudo-request:
request.server.get(...)condition fails becauserequest.serverisnull. The full exception message shows this:Solution
I propose to catch all exceptions in
TraceableUrlMatcherand display an error message with some details of the exception: