ApiExceptionRenderer.php

<?php

declare(strict_types=1);

namespace App\Exceptions;

use App\Support\ApiResponse;
use Illuminate\Auth\Access\AuthorizationException;
use Illuminate\Auth\AuthenticationException;
use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Http\JsonResponse;
use Illuminate\Http\Request;
use Illuminate\Validation\ValidationException;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
use Symfony\Component\HttpKernel\Exception\MethodNotAllowedHttpException;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
use Throwable;

/**
 * Turns any exception thrown behind an API route into the standard error envelope.
 */
final class ApiExceptionRenderer
{
    public function __invoke(Throwable $e, Request $request): ?JsonResponse
    {
        if (! $request->is('api/*')) {
            return null;
        }

        return match (true) {
            $e instanceof ValidationException => ApiResponse::error(
                'The given data was invalid.',
                Response::HTTP_UNPROCESSABLE_ENTITY,
                $e->errors(),
            ),
            $e instanceof AuthenticationException => ApiResponse::error(
                $e->getMessage(),
                Response::HTTP_UNAUTHORIZED,
            ),
            $e instanceof AuthorizationException => ApiResponse::error(
                'This action is unauthorized.',
                Response::HTTP_FORBIDDEN,
            ),
            $e instanceof ModelNotFoundException => ApiResponse::error(
                'Resource not found.',
                Response::HTTP_NOT_FOUND,
            ),
            $e instanceof NotFoundHttpException => ApiResponse::error(
                // Route model binding wraps a missing model in a 404 http exception.
                $e->getPrevious() instanceof ModelNotFoundException ? 'Resource not found.' : 'Endpoint not found.',
                Response::HTTP_NOT_FOUND,
            ),
            $e instanceof MethodNotAllowedHttpException => ApiResponse::error(
                'Method not allowed for this endpoint.',
                Response::HTTP_METHOD_NOT_ALLOWED,
            ),
            $e instanceof HttpExceptionInterface => ApiResponse::error(
                $e->getMessage() !== '' ? $e->getMessage() : 'Request failed.',
                $e->getStatusCode(),
            ),
            default => $this->unexpected($e),
        };
    }

    private function unexpected(Throwable $e): JsonResponse
    {
        return ApiResponse::error(
            config('app.debug') ? $e->getMessage() : 'Something went wrong, please try again later.',
            Response::HTTP_INTERNAL_SERVER_ERROR,
        );
    }
}