Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve error output for exception messages with special characters #131

Merged
merged 1 commit into from
Mar 25, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions examples/index.php
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,7 @@
$app->get('/error/yield', function () {
yield null;
});
$app->get('/error/class', 'Acme\Http\UnknownDeleteUserController');

// OPTIONS *
$app->options('', function () {
Expand Down
11 changes: 7 additions & 4 deletions src/HtmlHandler.php
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ public function statusResponse(int $statusCode, string $title, string $subtitle,
h1 { margin: 0 .5em 0 0; border-right: calc(2 * max(0px, min(100vw - 700px + 1px, 1px))) solid #e3e4e7; padding-right: .5em; color: #aebdcc; font-size: 3em; }
strong { color: #111827; font-size: 3em; }
p { margin: .5em 0 0 0; grid-column: 2; color: #6b7280; }
code { padding: 0 .3em; background-color: #f5f6f9; }
code { padding: 0 .3em; background-color: #f5f6f9; } code span { padding: 0 .2em; border-radius: 3px; background-color: #0001; }
a { color: inherit; }
</style>
</head>
Expand All @@ -50,13 +50,16 @@ public function statusResponse(int $statusCode, string $title, string $subtitle,

public function escape(string $s): string
{
return \addcslashes(
return \preg_replace_callback(
'/[\x00-\x1F]+/',
function (array $match): string {
return '<span>' . \addcslashes($match[0], "\x00..\xff") . '</span>';
},
\preg_replace(
'/(^| ) |(?: $)/',
'$1&nbsp;',
\htmlspecialchars($s, \ENT_NOQUOTES | \ENT_SUBSTITUTE | \ENT_DISALLOWED, 'utf-8')
),
"\0..\032\\"
)
);
}
}
12 changes: 6 additions & 6 deletions tests/AppTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -1329,27 +1329,27 @@ public function provideInvalidClasses()
{
yield [
InvalidConstructorPrivate::class,
'Cannot instantiate class ' . addslashes(InvalidConstructorPrivate::class)
'Cannot instantiate class ' . InvalidConstructorPrivate::class
];

yield [
InvalidConstructorProtected::class,
'Cannot instantiate class ' . addslashes(InvalidConstructorProtected::class)
'Cannot instantiate class ' . InvalidConstructorProtected::class
];

yield [
InvalidAbstract::class,
'Cannot instantiate abstract class ' . addslashes(InvalidAbstract::class)
'Cannot instantiate abstract class ' . InvalidAbstract::class
];

yield [
InvalidInterface::class,
'Cannot instantiate interface ' . addslashes(InvalidInterface::class)
'Cannot instantiate interface ' . InvalidInterface::class
];

yield [
InvalidTrait::class,
'Cannot instantiate trait ' . addslashes(InvalidTrait::class)
'Cannot instantiate trait ' . InvalidTrait::class
];

yield [
Expand Down Expand Up @@ -1413,7 +1413,7 @@ public function testHandleRequestWithMatchingRouteReturnsInternalServerErrorResp

$this->assertStringContainsString("<title>Error 500: Internal Server Error</title>\n", (string) $response->getBody());
$this->assertStringContainsString("<p>The requested page failed to load, please try again later.</p>\n", (string) $response->getBody());
$this->assertStringMatchesFormat("%a<p>Expected request handler to return <code>Psr\Http\Message\ResponseInterface</code> but got uncaught <code>BadMethodCallException</code> with message <code>Request handler class " . addslashes($class) . " failed to load: $error</code> in <code title=\"See %s\">Container.php:%d</code>.</p>\n%a", (string) $response->getBody());
$this->assertStringMatchesFormat("%a<p>Expected request handler to return <code>Psr\Http\Message\ResponseInterface</code> but got uncaught <code>BadMethodCallException</code> with message <code>Request handler class " . $class . " failed to load: $error</code> in <code title=\"See %s\">Container.php:%d</code>.</p>\n%a", (string) $response->getBody());
}

public function testHandleRequestWithMatchingRouteReturnsInternalServerErrorResponseWhenHandlerClassRequiresUnexpectedCallableParameter()
Expand Down
6 changes: 3 additions & 3 deletions tests/ErrorHandlerTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -407,15 +407,15 @@ public function provideExceptionMessage()
],
[
"new\n line",
'new\n line'
'new<span>\n</span> line'
],
[
'sla/she\'s\\n',
'sla/she\'s\\\\n'
'sla/she\'s\\n'
],
[
"hello\r\nworld",
'hello\r\nworld'
'hello<span>\r\n</span>world'
],
[
'"with"<html>',
Expand Down
6 changes: 3 additions & 3 deletions tests/HtmlHandlerTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -44,15 +44,15 @@ public function provideNames()
],
[
"hello\nworld",
'hello\nworld'
'hello<span>\n</span>world'
],
[
"hello\tworld",
'hello\tworld'
'hello<span>\t</span>world'
],
[
"hello\\nworld",
'hello\\\\nworld'
'hello\nworld'
],
[
'h<e>llo',
Expand Down