10489563861

Committed 21 Aug 2024 12:09PM UTC coverage: 7.704% (+2.4%) from 5.352%

Build # 10489563861

Build Type

push

github

Committed by

web-flow

Commit Message

chore(laravel): code cleanup (#6526)

* chore(laravel): code cleanup

* fix ci

* fix phpdoc

* fix review

* fix review

Run Details

0 of 11 new or added lines in 3 files covered. (0.0%)

1768 existing lines in 74 files now uncovered.

12476 of 161932 relevant lines covered (7.7%)

23.0 hits per line

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

0.0

/src/Laravel/State/SwaggerUiProcessor.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\State;

use ApiPlatform\Metadata\Exception\RuntimeException;
use ApiPlatform\Metadata\Operation;
use ApiPlatform\Metadata\UrlGeneratorInterface;
use ApiPlatform\OpenApi\OpenApi;
use ApiPlatform\OpenApi\Options;
use ApiPlatform\OpenApi\Serializer\NormalizeOperationNameTrait;
use ApiPlatform\State\ProcessorInterface;
use Illuminate\Http\Response;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;

/**
 * @internal
 *
 * @implements ProcessorInterface<OpenApi, Response>
 */
final class SwaggerUiProcessor implements ProcessorInterface
{
    use NormalizeOperationNameTrait;

    /**
     * @param array<string, string[]> $formats
     */
    public function __construct(
        private readonly UrlGeneratorInterface $urlGenerator,
        private readonly NormalizerInterface $normalizer,
        private readonly Options $openApiOptions,
        private readonly array $formats = [],
        private readonly ?string $oauthClientId = null,
        private readonly ?string $oauthClientSecret = null,
        private readonly bool $oauthPkce = false,
    ) {
    }

    /**
     * @param OpenApi $openApi
     */
    public function process(mixed $openApi, Operation $operation, array $uriVariables = [], array $context = []): Response
    {
        $request = $context['request'] ?? null;

        $swaggerContext = [
            'formats' => $this->formats,
            'title' => $openApi->getInfo()->getTitle(),
            'description' => $openApi->getInfo()->getDescription(),
            'originalRoute' => $request->attributes->get('_api_original_route', $request->attributes->get('_route')),
            'originalRouteParams' => $request->attributes->get('_api_original_route_params', $request->attributes->get('_route_params', [])),
        ];

        $swaggerData = [
            'url' => $this->urlGenerator->generate('api_doc', ['format' => 'json']),
            'spec' => $this->normalizer->normalize($openApi, 'json', []),
            'oauth' => [
                'enabled' => $this->openApiOptions->getOAuthEnabled(),
                'type' => $this->openApiOptions->getOAuthType(),
                'flow' => $this->openApiOptions->getOAuthFlow(),
                'tokenUrl' => $this->openApiOptions->getOAuthTokenUrl(),
                'authorizationUrl' => $this->openApiOptions->getOAuthAuthorizationUrl(),
                'scopes' => $this->openApiOptions->getOAuthScopes(),
                'clientId' => $this->oauthClientId,
                'clientSecret' => $this->oauthClientSecret,
                'pkce' => $this->oauthPkce,
            ],
        ];

        $status = 200;
        $requestedOperation = $request?->attributes->get('_api_requested_operation') ?? null;
        if ($request->isMethodSafe() && $requestedOperation && $requestedOperation->getName()) {
            $swaggerData['id'] = $request->get('id');
            $swaggerData['queryParameters'] = $request->query->all();

            $swaggerData['shortName'] = $requestedOperation->getShortName();
            $swaggerData['operationId'] = $this->normalizeOperationName($requestedOperation->getName());

            [$swaggerData['path'], $swaggerData['method']] = $this->getPathAndMethod($swaggerData);
            $status = $requestedOperation->getStatus() ?? $status;
        }

        return new Response(view('api-platform::swagger-ui', $swaggerContext + ['swagger_data' => $swaggerData]), 200);
    }

    /**
     * @param array<string, mixed> $swaggerData
     *
     * @return array{0: string, 1: string}
     */
    private function getPathAndMethod(array $swaggerData): array
    {
        foreach ($swaggerData['spec']['paths'] as $path => $operations) {
            foreach ($operations as $method => $operation) {
                if (($operation['operationId'] ?? null) === $swaggerData['operationId']) {
                    return [$path, $method];
                }
            }
        }

        throw new RuntimeException(\sprintf('The operation "%s" cannot be found in the Swagger specification.', $swaggerData['operationId']));
    }
}

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\State;
15
16	use ApiPlatform\Metadata\Exception\RuntimeException;
17	use ApiPlatform\Metadata\Operation;
18	use ApiPlatform\Metadata\UrlGeneratorInterface;
19	use ApiPlatform\OpenApi\OpenApi;
20	use ApiPlatform\OpenApi\Options;
21	use ApiPlatform\OpenApi\Serializer\NormalizeOperationNameTrait;
22	use ApiPlatform\State\ProcessorInterface;
23	use Illuminate\Http\Response;
24	use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
25
26	/**
27	* @internal
28	*
29	* @implements ProcessorInterface<OpenApi, Response>
30	*/
31	final class SwaggerUiProcessor implements ProcessorInterface
32	{
33	use NormalizeOperationNameTrait;
34
35	/**
36	* @param array<string, string[]> $formats
37	*/
38	public function __construct(
39	private readonly UrlGeneratorInterface $urlGenerator,
40	private readonly NormalizerInterface $normalizer,
41	private readonly Options $openApiOptions,
42	private readonly array $formats = [],
43	private readonly ?string $oauthClientId = null,
44	private readonly ?string $oauthClientSecret = null,
45	private readonly bool $oauthPkce = false,
46	) {
UNCOV 47	}	×
48
49	/**
50	* @param OpenApi $openApi
51	*/
52	public function process(mixed $openApi, Operation $operation, array $uriVariables = [], array $context = []): Response
53	{
54	$request = $context['request'] ?? null;	×
55
56	$swaggerContext = [	×
57	'formats' => $this->formats,	×
58	'title' => $openApi->getInfo()->getTitle(),	×
59	'description' => $openApi->getInfo()->getDescription(),	×
60	'originalRoute' => $request->attributes->get('_api_original_route', $request->attributes->get('_route')),	×
61	'originalRouteParams' => $request->attributes->get('_api_original_route_params', $request->attributes->get('_route_params', [])),	×
62	];	×
63
64	$swaggerData = [	×
65	'url' => $this->urlGenerator->generate('api_doc', ['format' => 'json']),	×
66	'spec' => $this->normalizer->normalize($openApi, 'json', []),	×
67	'oauth' => [	×
68	'enabled' => $this->openApiOptions->getOAuthEnabled(),	×
69	'type' => $this->openApiOptions->getOAuthType(),	×
70	'flow' => $this->openApiOptions->getOAuthFlow(),	×
71	'tokenUrl' => $this->openApiOptions->getOAuthTokenUrl(),	×
72	'authorizationUrl' => $this->openApiOptions->getOAuthAuthorizationUrl(),	×
73	'scopes' => $this->openApiOptions->getOAuthScopes(),	×
74	'clientId' => $this->oauthClientId,	×
75	'clientSecret' => $this->oauthClientSecret,	×
76	'pkce' => $this->oauthPkce,	×
77	],	×
78	];	×
79
80	$status = 200;	×
81	$requestedOperation = $request?->attributes->get('_api_requested_operation') ?? null;	×
82	if ($request->isMethodSafe() && $requestedOperation && $requestedOperation->getName()) {	×
83	$swaggerData['id'] = $request->get('id');	×
84	$swaggerData['queryParameters'] = $request->query->all();	×
85
86	$swaggerData['shortName'] = $requestedOperation->getShortName();	×
87	$swaggerData['operationId'] = $this->normalizeOperationName($requestedOperation->getName());	×
88
89	[$swaggerData['path'], $swaggerData['method']] = $this->getPathAndMethod($swaggerData);	×
90	$status = $requestedOperation->getStatus() ?? $status;	×
91	}
92
93	return new Response(view('api-platform::swagger-ui', $swaggerContext + ['swagger_data' => $swaggerData]), 200);	×
94	}
95
96	/**
97	* @param array<string, mixed> $swaggerData
98	*
99	* @return array{0: string, 1: string}
100	*/
101	private function getPathAndMethod(array $swaggerData): array
102	{
103	foreach ($swaggerData['spec']['paths'] as $path => $operations) {	×
104	foreach ($operations as $method => $operation) {	×
105	if (($operation['operationId'] ?? null) === $swaggerData['operationId']) {	×
106	return [$path, $method];	×
107	}
108	}
109	}
110
111	throw new RuntimeException(\sprintf('The operation "%s" cannot be found in the Swagger specification.', $swaggerData['operationId']));	×
112	}
113	}

api-platform / core / 10489563861

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