mirrors/rss-bridge
1
0
Fork 0
mirror of https://github.com/RSS-Bridge/rss-bridge.git synced 2025-03-14 20:21:14 +03:00
Code Issues Projects Releases Packages Wiki Activity

feat: improve error handling ux (#3298)

Browse source 
* feat: improve error handling ux

* feat: add error messages for failed xml parsing
This commit is contained in:
Dag 2023-03-20 19:11:51 +01:00 • committed by GitHub
parent 9e9a697b8b
commit 4c3ebb312d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 70 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
lib/FeedExpander.php
View file

@ -102,7 +102,7 @@ abstract class FeedExpander extends BridgeAbstract
$httpHeaders = ['Accept: ' . implode(', ', $mimeTypes)];
$content = getContents($url, $httpHeaders);
if ($content === '') {
throw new \Exception(sprintf('Unable to parse xml from `%s` because we got the empty string', $url));
throw new \Exception(sprintf('Unable to parse xml from `%s` because we got the empty string', $url), 10);
}
// Maybe move this call earlier up the stack frames
// Disable triggering of the php error-handler and handle errors manually instead
@ -121,7 +121,7 @@ abstract class FeedExpander extends BridgeAbstract
// Render only the first error into exception message
$firstXmlErrorMessage = $xmlErrors[0]->message;
}
throw new \Exception(sprintf('Unable to parse xml from `%s` %s', $url, $firstXmlErrorMessage ?? ''));
throw new \Exception(sprintf('Unable to parse xml from `%s` %s', $url, $firstXmlErrorMessage ?? ''), 11);
}
// Restore previous behaviour in case other code relies on it being off
libxml_use_internal_errors(false);

43
lib/contents.php
View file

@ -178,29 +178,28 @@ function getContents(
$response['content'] = $cache->loadData();
break;
default:
if (Debug::isEnabled()) {
// Include a part of the response body in the exception message
throw new HttpException(
sprintf(
'%s resulted in `%s %s: %s`',
$url,
$result['code'],
Response::STATUS_CODES[$result['code']] ?? '',
mb_substr($result['body'], 0, 500),
),
$result['code']
);
} else {
throw new HttpException(
sprintf(
'%s resulted in `%s %s`',
$url,
$result['code'],
Response::STATUS_CODES[$result['code']] ?? '',
),
$result['code']
);
$exceptionMessage = sprintf(
'%s resulted in %s %s %s',
$url,
$result['code'],
Response::STATUS_CODES[$result['code']] ?? '',
// If debug, include a part of the response body in the exception message
Debug::isEnabled() ? mb_substr($result['body'], 0, 500) : '',
);
// The following code must be extracted if it grows too much
$cloudflareTitles = [
'<title>Just a moment...',
'<title>Please Wait...',
'<title>Attention Required!'
];
foreach ($cloudflareTitles as $cloudflareTitle) {
if (str_contains($result['body'], $cloudflareTitle)) {
throw new CloudFlareException($exceptionMessage, $result['code']);
}
}
throw new HttpException($exceptionMessage, $result['code']);
}
if ($returnFull === true) {
return $response;

6
lib/utils.php
View file

@ -1,6 +1,10 @@
<?php
final class HttpException extends \Exception
class HttpException extends \Exception
{
}
final class CloudFlareException extends HttpException
{
}

44
templates/error.html.php
View file

@ -1,8 +1,48 @@
<div class="error">
<h1>Application Error</h1>
<?php if ($e instanceof HttpException): ?>
<?php if ($e instanceof CloudFlareException): ?>
<h2>The website is protected by CloudFlare</h2>
<p>
RSS-Bridge tried to fetch a website.
The fetching was blocked by CloudFlare.
CloudFlare is anti-bot software.
Its purpose is to block non-humans.
</p>
<?php endif; ?>
<p>The application could not run because of the following error:</p>
<?php if ($e->getCode() === 404): ?>
<h2>The website was not found</h2>
<p>
RSS-Bridge tried to fetch a page on a website.
But it doesn't exists.
</p>
<?php endif; ?>
<?php if ($e->getCode() === 429): ?>
<h2>Try again later</h2>
<p>
RSS-Bridge tried to fetch a website.
They told us to try again later.
</p>
<?php endif; ?>
<?php else: ?>
<?php if ($e->getCode() === 10): ?>
<h2>The rss feed is completely empty</h2>
<p>
RSS-Bridge tried parse the empty string as xml.
The fetched url is not pointing to real xml.
</p>
<?php endif; ?>
<?php if ($e->getCode() === 11): ?>
<h2>There is something wrong with the rss feed</h2>
<p>
RSS-Bridge tried parse xml. It failed. The xml is probably broken.
</p>
<?php endif; ?>
<?php endif; ?>
<h2>Details</h2>