Refactor notify exception to clean up api exception handling

This commit is contained in:
Thomas Kuschan 2023-06-14 11:07:13 +02:00
parent 321a459421
commit 34d8268b2b
2 changed files with 36 additions and 8 deletions

View File

@ -103,10 +103,6 @@ class Handler extends ExceptionHandler
$code = $e->status; $code = $e->status;
} }
if (method_exists($e, 'getStatus')) {
$code = $e->getStatus();
}
$responseData['error']['code'] = $code; $responseData['error']['code'] = $code;
return new JsonResponse($responseData, $code, $headers); return new JsonResponse($responseData, $code, $headers);

View File

@ -4,29 +4,61 @@ namespace BookStack\Exceptions;
use Exception; use Exception;
use Illuminate\Contracts\Support\Responsable; use Illuminate\Contracts\Support\Responsable;
use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
class NotifyException extends Exception implements Responsable class NotifyException extends Exception implements Responsable, HttpExceptionInterface
{ {
public $message; public $message;
public $redirectLocation; public $redirectLocation;
protected $status; protected $status;
/**
* @var array<mixed>
*/
protected array $headers = [];
public function __construct(string $message, string $redirectLocation = '/', int $status = 500) public function __construct(string $message, string $redirectLocation = '/', int $status = 500)
{ {
$this->message = $message; $this->message = $message;
$this->redirectLocation = $redirectLocation; $this->redirectLocation = $redirectLocation;
$this->status = $status; $this->status = $status;
if ($status >= 300 && $status < 400) {
// add redirect header only when a matching HTTP status is given
$this->headers = ['location' => $redirectLocation];
}
parent::__construct(); parent::__construct();
} }
/** /**
* Get the desired status code for this exception. * Get the desired HTTP status code for this exception.
*
* {@inheritdoc}
*/ */
public function getStatus(): int public function getStatusCode(): int
{ {
return $this->status; return $this->status;
} }
/**
* Get the desired HTTP headers for this exception.
*
* {@inheritdoc}
*/
public function getHeaders(): array
{
return $this->headers;
}
/**
* @param array<mixed> $headers
*/
public function setHeaders(array $headers): void
{
$this->headers = $headers;
}
/** /**
* Send the response for this type of exception. * Send the response for this type of exception.
* *
@ -38,7 +70,7 @@ class NotifyException extends Exception implements Responsable
// Front-end JSON handling. API-side handling managed via handler. // Front-end JSON handling. API-side handling managed via handler.
if ($request->wantsJson()) { if ($request->wantsJson()) {
return response()->json(['error' => $message], 403); return response()->json(['error' => $message], $this->getStatusCode());
} }
if (!empty($message)) { if (!empty($message)) {