10903050455

Committed 17 Sep 2024 12:29PM UTC coverage: 7.684% (+0.7%) from 6.96%

Build # 10903050455

Build Type

push

github

Committed by

web-flow

Commit Message

fix: swagger ui with route identifier (#6616)

Run Details

2 of 6 new or added lines in 6 files covered. (33.33%)

9000 existing lines in 286 files now uncovered.

12668 of 164863 relevant lines covered (7.68%)

22.93 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/src/Laravel/Exception/ErrorHandler.php

<?php

/*
 * This file is part of the API Platform project.
 *
 * (c) Kévin Dunglas <dunglas@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace ApiPlatform\Laravel\Exception;

use ApiPlatform\Laravel\ApiResource\Error;
use ApiPlatform\Laravel\Controller\ApiPlatformController;
use ApiPlatform\Metadata\Exception\ProblemExceptionInterface;
use ApiPlatform\Metadata\Exception\StatusAwareExceptionInterface;
use ApiPlatform\Metadata\HttpOperation;
use ApiPlatform\Metadata\IdentifiersExtractorInterface;
use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
use ApiPlatform\Metadata\ResourceClassResolverInterface;
use ApiPlatform\Metadata\Util\ContentNegotiationTrait;
use ApiPlatform\State\Util\OperationRequestInitiatorTrait;
use Illuminate\Auth\Access\AuthorizationException;
use Illuminate\Auth\AuthenticationException;
use Illuminate\Contracts\Container\Container;
use Illuminate\Foundation\Exceptions\Handler as ExceptionsHandler;
use Illuminate\Http\Request;
use Negotiation\Negotiator;
use Symfony\Component\HttpFoundation\Exception\RequestExceptionInterface;
use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface as SymfonyHttpExceptionInterface;
use Symfony\Component\Serializer\Normalizer\AbstractObjectNormalizer;

class ErrorHandler extends ExceptionsHandler
{
    use ContentNegotiationTrait;
    use OperationRequestInitiatorTrait;

    public static mixed $error;

    /**
     * @param array<class-string, int> $exceptionToStatus
     */
    public function __construct(
        Container $container,
        ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory,
        private readonly ApiPlatformController $apiPlatformController,
        private readonly ?IdentifiersExtractorInterface $identifiersExtractor = null,
        private readonly ?ResourceClassResolverInterface $resourceClassResolver = null,
        ?Negotiator $negotiator = null,
        private readonly ?array $exceptionToStatus = null,
        private readonly ?bool $debug = false,
    ) {
        $this->resourceMetadataCollectionFactory = $resourceMetadataCollectionFactory;
        $this->negotiator = $negotiator;
        // calls register
        parent::__construct($container);
        $this->register();
    }

    public function register(): void
    {
        $this->renderable(function (\Throwable $exception, Request $request) {
            $apiOperation = $this->initializeOperation($request);
            if (!$apiOperation) {
                return null;
            }

            $formats = config('api-platform.error_formats') ?? ['jsonproblem' => ['application/problem+json']];
            $format = $request->getRequestFormat() ?? $this->getRequestFormat($request, $formats, false);

            if ($this->resourceClassResolver->isResourceClass($exception::class)) {
                $resourceCollection = $this->resourceMetadataCollectionFactory->create($exception::class);

                $operation = null;
                foreach ($resourceCollection as $resource) {
                    foreach ($resource->getOperations() as $op) {
                        foreach ($op->getOutputFormats() as $key => $value) {
                            if ($key === $format) {
                                $operation = $op;
                                break 3;
                            }
                        }
                    }
                }

                // No operation found for the requested format, we take the first available
                if (!$operation) {
                    $operation = $resourceCollection->getOperation();
                }
                $errorResource = $exception;
                if ($errorResource instanceof ProblemExceptionInterface && $operation instanceof HttpOperation) {
                    $statusCode = $this->getStatusCode($apiOperation, $operation, $exception);
                    $operation = $operation->withStatus($statusCode);
                    if ($errorResource instanceof StatusAwareExceptionInterface) {
                        $errorResource->setStatus($statusCode);
                    }
                }
            } else {
                // Create a generic, rfc7807 compatible error according to the wanted format
                $operation = $this->resourceMetadataCollectionFactory->create(Error::class)->getOperation($this->getFormatOperation($format));
                // status code may be overridden by the exceptionToStatus option
                $statusCode = 500;
                if ($operation instanceof HttpOperation) {
                    $statusCode = $this->getStatusCode($apiOperation, $operation, $exception);
                    $operation = $operation->withStatus($statusCode);
                }

                $errorResource = Error::createFromException($exception, $statusCode);
            }

            /** @var HttpOperation $operation */
            if (!$operation->getProvider()) {
                // TODO: validation
                // static::$error = 'jsonapi' === $format && $errorResource instanceof ConstraintViolationListAwareExceptionInterface ? $errorResource->getConstraintViolationList() : $errorResource;
                static::$error = $errorResource;
                $operation = $operation->withProvider([self::class, 'provide']);
            }

            // For our swagger Ui errors
            if ('html' === $format) {
                $operation = $operation->withOutputFormats(['html' => ['text/html']]);
            }

            $identifiers = [];
            try {
                $identifiers = $this->identifiersExtractor?->getIdentifiersFromItem($errorResource, $operation) ?? [];
            } catch (\Exception $e) {
            }

            $normalizationContext = $operation->getNormalizationContext() ?? [];
            if (!($normalizationContext['api_error_resource'] ?? false)) {
                $normalizationContext += ['api_error_resource' => true];
            }

            if (!isset($normalizationContext[AbstractObjectNormalizer::IGNORED_ATTRIBUTES])) {
                $normalizationContext[AbstractObjectNormalizer::IGNORED_ATTRIBUTES] = true === $this->debug ? [] : ['originalTrace'];
            }

            $operation = $operation->withNormalizationContext($normalizationContext);

            $dup = $request->duplicate(null, null, []);
            $dup->setMethod('GET');
            $dup->attributes->set('_api_resource_class', $operation->getClass());
            $dup->attributes->set('_api_previous_operation', $apiOperation);
            $dup->attributes->set('_api_operation', $operation);
            $dup->attributes->set('_api_operation_name', $operation->getName());
            $dup->attributes->remove('exception');
            // These are for swagger
            $dup->attributes->set('_api_original_route', $request->attributes->get('_route'));
            $dup->attributes->set('_api_original_uri_variables', $request->attributes->get('_api_uri_variables'));
            $dup->attributes->set('_api_original_route_params', $request->attributes->get('_route_params'));
            $dup->attributes->set('_api_requested_operation', $request->attributes->get('_api_requested_operation'));

            foreach ($identifiers as $name => $value) {
                $dup->attributes->set($name, $value);
            }

            return $this->apiPlatformController->__invoke($dup);
        });
    }

    private function getStatusCode(?HttpOperation $apiOperation, ?HttpOperation $errorOperation, \Throwable $exception): int
    {
        $exceptionToStatus = array_merge(
            $apiOperation ? $apiOperation->getExceptionToStatus() ?? [] : [],
            $errorOperation ? $errorOperation->getExceptionToStatus() ?? [] : [],
            $this->exceptionToStatus ?? []
        );

        foreach ($exceptionToStatus as $class => $status) {
            if (is_a($exception::class, $class, true)) {
                return $status;
            }
        }

        if ($exception instanceof AuthenticationException) {
            return 401;
        }

        if ($exception instanceof AuthorizationException) {
            return 403;
        }

        if ($exception instanceof SymfonyHttpExceptionInterface) {
            return $exception->getStatusCode();
        }

        if ($exception instanceof SymfonyHttpExceptionInterface) {
            return $exception->getStatusCode();
        }

        if ($exception instanceof RequestExceptionInterface) {
            return 400;
        }

        // if ($exception instanceof ValidationException) {
        //     return 422;
        // }

        if ($status = $errorOperation?->getStatus()) {
            return $status;
        }

        return 500;
    }

    private function getFormatOperation(?string $format): string
    {
        return match ($format) {
            'json' => '_api_errors_problem',
            'jsonproblem' => '_api_errors_problem',
            'jsonld' => '_api_errors_hydra',
            'jsonapi' => '_api_errors_jsonapi',
            'html' => '_api_errors_problem', // This will be intercepted by the SwaggerUiProvider
            default => '_api_errors_problem',
        };
    }

    public static function provide(): mixed
    {
        if ($data = static::$error) {
            return $data;
        }

        throw new \LogicException(\sprintf('We could not find the thrown exception in the %s.', self::class));
    }
}

1	<?php
2
3	/*
4	* This file is part of the API Platform project.
5	*
6	* (c) Kévin Dunglas <dunglas@gmail.com>
7	*
8	* For the full copyright and license information, please view the LICENSE
9	* file that was distributed with this source code.
10	*/
11
12	declare(strict_types=1);
13
14	namespace ApiPlatform\Laravel\Exception;
15
16	use ApiPlatform\Laravel\ApiResource\Error;
17	use ApiPlatform\Laravel\Controller\ApiPlatformController;
18	use ApiPlatform\Metadata\Exception\ProblemExceptionInterface;
19	use ApiPlatform\Metadata\Exception\StatusAwareExceptionInterface;
20	use ApiPlatform\Metadata\HttpOperation;
21	use ApiPlatform\Metadata\IdentifiersExtractorInterface;
22	use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
23	use ApiPlatform\Metadata\ResourceClassResolverInterface;
24	use ApiPlatform\Metadata\Util\ContentNegotiationTrait;
25	use ApiPlatform\State\Util\OperationRequestInitiatorTrait;
26	use Illuminate\Auth\Access\AuthorizationException;
27	use Illuminate\Auth\AuthenticationException;
28	use Illuminate\Contracts\Container\Container;
29	use Illuminate\Foundation\Exceptions\Handler as ExceptionsHandler;
30	use Illuminate\Http\Request;
31	use Negotiation\Negotiator;
32	use Symfony\Component\HttpFoundation\Exception\RequestExceptionInterface;
33	use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface as SymfonyHttpExceptionInterface;
34	use Symfony\Component\Serializer\Normalizer\AbstractObjectNormalizer;
35
36	class ErrorHandler extends ExceptionsHandler
37	{
38	use ContentNegotiationTrait;
39	use OperationRequestInitiatorTrait;
40
41	public static mixed $error;
42
43	/**
44	* @param array<class-string, int> $exceptionToStatus
45	*/
46	public function __construct(
47	Container $container,
48	ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory,
49	private readonly ApiPlatformController $apiPlatformController,
50	private readonly ?IdentifiersExtractorInterface $identifiersExtractor = null,
51	private readonly ?ResourceClassResolverInterface $resourceClassResolver = null,
52	?Negotiator $negotiator = null,
53	private readonly ?array $exceptionToStatus = null,
54	private readonly ?bool $debug = false,
55	) {
56	$this->resourceMetadataCollectionFactory = $resourceMetadataCollectionFactory;	×
57	$this->negotiator = $negotiator;	×
58	// calls register
59	parent::__construct($container);	×
60	$this->register();	×
61	}
62
63	public function register(): void
64	{
65	$this->renderable(function (\Throwable $exception, Request $request) {	×
66	$apiOperation = $this->initializeOperation($request);	×
67	if (!$apiOperation) {	×
68	return null;	×
69	}
70
71	$formats = config('api-platform.error_formats') ?? ['jsonproblem' => ['application/problem+json']];	×
72	$format = $request->getRequestFormat() ?? $this->getRequestFormat($request, $formats, false);	×
73
74	if ($this->resourceClassResolver->isResourceClass($exception::class)) {	×
75	$resourceCollection = $this->resourceMetadataCollectionFactory->create($exception::class);	×
76
77	$operation = null;	×
78	foreach ($resourceCollection as $resource) {	×
79	foreach ($resource->getOperations() as $op) {	×
80	foreach ($op->getOutputFormats() as $key => $value) {	×
81	if ($key === $format) {	×
82	$operation = $op;	×
83	break 3;	×
84	}
85	}
86	}
87	}
88
89	// No operation found for the requested format, we take the first available
90	if (!$operation) {	×
91	$operation = $resourceCollection->getOperation();	×
92	}
93	$errorResource = $exception;	×
94	if ($errorResource instanceof ProblemExceptionInterface && $operation instanceof HttpOperation) {	×
95	$statusCode = $this->getStatusCode($apiOperation, $operation, $exception);	×
96	$operation = $operation->withStatus($statusCode);	×
97	if ($errorResource instanceof StatusAwareExceptionInterface) {	×
98	$errorResource->setStatus($statusCode);	×
99	}
100	}
101	} else {
102	// Create a generic, rfc7807 compatible error according to the wanted format
103	$operation = $this->resourceMetadataCollectionFactory->create(Error::class)->getOperation($this->getFormatOperation($format));	×
104	// status code may be overridden by the exceptionToStatus option
105	$statusCode = 500;	×
106	if ($operation instanceof HttpOperation) {	×
107	$statusCode = $this->getStatusCode($apiOperation, $operation, $exception);	×
108	$operation = $operation->withStatus($statusCode);	×
109	}
110
111	$errorResource = Error::createFromException($exception, $statusCode);	×
112	}
113
114	/** @var HttpOperation $operation */
115	if (!$operation->getProvider()) {	×
116	// TODO: validation
117	// static::$error = 'jsonapi' === $format && $errorResource instanceof ConstraintViolationListAwareExceptionInterface ? $errorResource->getConstraintViolationList() : $errorResource;
118	static::$error = $errorResource;	×
119	$operation = $operation->withProvider([self::class, 'provide']);	×
120	}
121
122	// For our swagger Ui errors
123	if ('html' === $format) {	×
124	$operation = $operation->withOutputFormats(['html' => ['text/html']]);	×
125	}
126
127	$identifiers = [];	×
128	try {
129	$identifiers = $this->identifiersExtractor?->getIdentifiersFromItem($errorResource, $operation) ?? [];	×
130	} catch (\Exception $e) {	×
131	}
132
133	$normalizationContext = $operation->getNormalizationContext() ?? [];	×
134	if (!($normalizationContext['api_error_resource'] ?? false)) {	×
135	$normalizationContext += ['api_error_resource' => true];	×
136	}
137
138	if (!isset($normalizationContext[AbstractObjectNormalizer::IGNORED_ATTRIBUTES])) {	×
139	$normalizationContext[AbstractObjectNormalizer::IGNORED_ATTRIBUTES] = true === $this->debug ? [] : ['originalTrace'];	×
140	}
141
142	$operation = $operation->withNormalizationContext($normalizationContext);	×
143
144	$dup = $request->duplicate(null, null, []);	×
145	$dup->setMethod('GET');	×
146	$dup->attributes->set('_api_resource_class', $operation->getClass());	×
147	$dup->attributes->set('_api_previous_operation', $apiOperation);	×
148	$dup->attributes->set('_api_operation', $operation);	×
149	$dup->attributes->set('_api_operation_name', $operation->getName());	×
150	$dup->attributes->remove('exception');	×
151	// These are for swagger
152	$dup->attributes->set('_api_original_route', $request->attributes->get('_route'));	×
NEW 153	$dup->attributes->set('_api_original_uri_variables', $request->attributes->get('_api_uri_variables'));	×
154	$dup->attributes->set('_api_original_route_params', $request->attributes->get('_route_params'));	×
155	$dup->attributes->set('_api_requested_operation', $request->attributes->get('_api_requested_operation'));	×
156
157	foreach ($identifiers as $name => $value) {	×
158	$dup->attributes->set($name, $value);	×
159	}
160
161	return $this->apiPlatformController->__invoke($dup);	×
162	});	×
163	}
164
165	private function getStatusCode(?HttpOperation $apiOperation, ?HttpOperation $errorOperation, \Throwable $exception): int
166	{
167	$exceptionToStatus = array_merge(	×
168	$apiOperation ? $apiOperation->getExceptionToStatus() ?? [] : [],	×
169	$errorOperation ? $errorOperation->getExceptionToStatus() ?? [] : [],	×
170	$this->exceptionToStatus ?? []	×
171	);	×
172
173	foreach ($exceptionToStatus as $class => $status) {	×
174	if (is_a($exception::class, $class, true)) {	×
175	return $status;	×
176	}
177	}
178
179	if ($exception instanceof AuthenticationException) {	×
180	return 401;	×
181	}
182
183	if ($exception instanceof AuthorizationException) {	×
184	return 403;	×
185	}
186
187	if ($exception instanceof SymfonyHttpExceptionInterface) {	×
188	return $exception->getStatusCode();	×
189	}
190
191	if ($exception instanceof SymfonyHttpExceptionInterface) {	×
192	return $exception->getStatusCode();	×
193	}
194
195	if ($exception instanceof RequestExceptionInterface) {	×
196	return 400;	×
197	}
198
199	// if ($exception instanceof ValidationException) {
200	// return 422;
201	// }
202
203	if ($status = $errorOperation?->getStatus()) {	×
204	return $status;	×
205	}
206
207	return 500;	×
208	}
209
210	private function getFormatOperation(?string $format): string
211	{
212	return match ($format) {	×
213	'json' => '_api_errors_problem',	×
214	'jsonproblem' => '_api_errors_problem',	×
215	'jsonld' => '_api_errors_hydra',	×
216	'jsonapi' => '_api_errors_jsonapi',	×
217	'html' => '_api_errors_problem', // This will be intercepted by the SwaggerUiProvider	×
218	default => '_api_errors_problem',	×
219	};	×
220	}
221
222	public static function provide(): mixed
223	{
224	if ($data = static::$error) {	×
225	return $data;	×
226	}
227
228	throw new \LogicException(\sprintf('We could not find the thrown exception in the %s.', self::class));	×
229	}
230	}

api-platform / core / 10903050455

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous