9562658349

Committed 18 Jun 2024 09:35AM UTC coverage: 62.637% (+0.4%) from 62.272%

Build # 9562658349

Build Type

push

github

Committed by

soyuka

Commit Message

Merge 3.4

Run Details

52 of 55 new or added lines in 6 files covered. (94.55%)

236 existing lines in 20 files now uncovered.

11016 of 17587 relevant lines covered (62.64%)

60.45 hits per line

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

93.62

/src/State/Processor/RespondProcessor.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\State\Processor;

use ApiPlatform\Metadata\Exception\HttpExceptionInterface;
use ApiPlatform\Metadata\HttpOperation;
use ApiPlatform\Metadata\IriConverterInterface;
use ApiPlatform\Metadata\Operation;
use ApiPlatform\Metadata\Operation\Factory\OperationMetadataFactoryInterface;
use ApiPlatform\Metadata\Put;
use ApiPlatform\Metadata\ResourceClassResolverInterface;
use ApiPlatform\Metadata\UrlGeneratorInterface;
use ApiPlatform\Metadata\Util\ClassInfoTrait;
use ApiPlatform\Metadata\Util\CloneTrait;
use ApiPlatform\State\ProcessorInterface;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface as SymfonyHttpExceptionInterface;

/**
 * Serializes data.
 *
 * @author Kévin Dunglas <dunglas@gmail.com>
 */
final class RespondProcessor implements ProcessorInterface
{
    use ClassInfoTrait;
    use CloneTrait;

    public const METHOD_TO_CODE = [
        'POST' => Response::HTTP_CREATED,
        'DELETE' => Response::HTTP_NO_CONTENT,
    ];

    public function __construct(
        private ?IriConverterInterface $iriConverter = null,
        private readonly ?ResourceClassResolverInterface $resourceClassResolver = null,
        private readonly ?OperationMetadataFactoryInterface $operationMetadataFactory = null,
    ) {
    }

    public function process(mixed $data, Operation $operation, array $uriVariables = [], array $context = [])
    {
        if ($data instanceof Response || !$operation instanceof HttpOperation) {
            return $data;
        }

        if (!($request = $context['request'] ?? null)) {
            return $data;
        }

        $headers = [
            'Content-Type' => sprintf('%s; charset=utf-8', $request->getMimeType($request->getRequestFormat())),
            'Vary' => 'Accept',
            'X-Content-Type-Options' => 'nosniff',
            'X-Frame-Options' => 'deny',
        ];

        $exception = $request->attributes->get('exception');
        if (($exception instanceof HttpExceptionInterface || $exception instanceof SymfonyHttpExceptionInterface) && $exceptionHeaders = $exception->getHeaders()) {
            $headers = array_merge($headers, $exceptionHeaders);
        }

        if ($operationHeaders = $operation->getHeaders()) {
            $headers = array_merge($headers, $operationHeaders);
        }

        $status = $operation->getStatus();

        if ($sunset = $operation->getSunset()) {
            $headers['Sunset'] = (new \DateTimeImmutable($sunset))->format(\DateTimeInterface::RFC1123);
        }

        if ($acceptPatch = $operation->getAcceptPatch()) {
            $headers['Accept-Patch'] = $acceptPatch;
        }

        $method = $request->getMethod();
        $originalData = $context['original_data'] ?? null;

        $outputMetadata = $operation->getOutput() ?? ['class' => $operation->getClass()];
        $hasOutput = \is_array($outputMetadata) && \array_key_exists('class', $outputMetadata) && null !== $outputMetadata['class'];
        $hasData = !$hasOutput ? false : ($this->resourceClassResolver && $originalData && \is_object($originalData) && $this->resourceClassResolver->isResourceClass($this->getObjectClass($originalData)));

        if ($hasData && $this->iriConverter) {
            if (
                !isset($headers['Location'])
                && 300 <= $status && $status < 400
                && (($operation->getExtraProperties()['is_alternate_resource_metadata'] ?? false) || ($operation->getExtraProperties()['canonical_uri_template'] ?? null))
            ) {
                $canonicalOperation = $operation;
                if ($this->operationMetadataFactory && null !== ($operation->getExtraProperties()['canonical_uri_template'] ?? null)) {
                    $canonicalOperation = $this->operationMetadataFactory->create($operation->getExtraProperties()['canonical_uri_template'], $context);
                }

                $headers['Location'] = $this->iriConverter->getIriFromResource($originalData, UrlGeneratorInterface::ABS_PATH, $canonicalOperation);
            } elseif ('PUT' === $method && !$request->attributes->get('previous_data') && null === $status && ($operation instanceof Put && ($operation->getAllowCreate() ?? false))) {
                $status = 201;
            }
        }

        $status ??= self::METHOD_TO_CODE[$method] ?? 200;

        if ($hasData && $this->iriConverter && !isset($headers['Content-Location'])) {
            $iri = $this->iriConverter->getIriFromResource($originalData);
            $headers['Content-Location'] = $iri;

            if ((201 === $status || (300 <= $status && $status < 400)) && 'POST' === $method && !isset($headers['Location'])) {
                $headers['Location'] = $iri;
            }
        }

        return new Response(
            $data,
            $status,
            $headers
        );
    }
}

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\State\Processor;
15
16	use ApiPlatform\Metadata\Exception\HttpExceptionInterface;
17	use ApiPlatform\Metadata\HttpOperation;
18	use ApiPlatform\Metadata\IriConverterInterface;
19	use ApiPlatform\Metadata\Operation;
20	use ApiPlatform\Metadata\Operation\Factory\OperationMetadataFactoryInterface;
21	use ApiPlatform\Metadata\Put;
22	use ApiPlatform\Metadata\ResourceClassResolverInterface;
23	use ApiPlatform\Metadata\UrlGeneratorInterface;
24	use ApiPlatform\Metadata\Util\ClassInfoTrait;
25	use ApiPlatform\Metadata\Util\CloneTrait;
26	use ApiPlatform\State\ProcessorInterface;
27	use Symfony\Component\HttpFoundation\Response;
28	use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface as SymfonyHttpExceptionInterface;
29
30	/**
31	* Serializes data.
32	*
33	* @author Kévin Dunglas <dunglas@gmail.com>
34	*/
35	final class RespondProcessor implements ProcessorInterface
36	{
37	use ClassInfoTrait;
38	use CloneTrait;
39
40	public const METHOD_TO_CODE = [
41	'POST' => Response::HTTP_CREATED,
42	'DELETE' => Response::HTTP_NO_CONTENT,
43	];
44
45	public function __construct(
46	private ?IriConverterInterface $iriConverter = null,
47	private readonly ?ResourceClassResolverInterface $resourceClassResolver = null,
48	private readonly ?OperationMetadataFactoryInterface $operationMetadataFactory = null,
49	) {
50	}	316✔
51
52	public function process(mixed $data, Operation $operation, array $uriVariables = [], array $context = [])
53	{
54	if ($data instanceof Response \|\| !$operation instanceof HttpOperation) {	312✔
55	return $data;	8✔
56	}
57
58	if (!($request = $context['request'] ?? null)) {	304✔
59	return $data;	×
60	}
61
62	$headers = [	304✔
63	'Content-Type' => sprintf('%s; charset=utf-8', $request->getMimeType($request->getRequestFormat())),	304✔
64	'Vary' => 'Accept',	304✔
65	'X-Content-Type-Options' => 'nosniff',	304✔
66	'X-Frame-Options' => 'deny',	304✔
67	];	304✔
68
69	$exception = $request->attributes->get('exception');	304✔
70	if (($exception instanceof HttpExceptionInterface \|\| $exception instanceof SymfonyHttpExceptionInterface) && $exceptionHeaders = $exception->getHeaders()) {	304✔
71	$headers = array_merge($headers, $exceptionHeaders);	4✔
72	}
73
74	if ($operationHeaders = $operation->getHeaders()) {	304✔
75	$headers = array_merge($headers, $operationHeaders);	4✔
76	}
77
78	$status = $operation->getStatus();	304✔
79
80	if ($sunset = $operation->getSunset()) {	304✔
81	$headers['Sunset'] = (new \DateTimeImmutable($sunset))->format(\DateTimeInterface::RFC1123);	×
82	}
83
84	if ($acceptPatch = $operation->getAcceptPatch()) {	304✔
85	$headers['Accept-Patch'] = $acceptPatch;	40✔
86	}
87
88	$method = $request->getMethod();	304✔
89	$originalData = $context['original_data'] ?? null;	304✔
90
91	$outputMetadata = $operation->getOutput() ?? ['class' => $operation->getClass()];	304✔
92	$hasOutput = \is_array($outputMetadata) && \array_key_exists('class', $outputMetadata) && null !== $outputMetadata['class'];	304✔
93	$hasData = !$hasOutput ? false : ($this->resourceClassResolver && $originalData && \is_object($originalData) && $this->resourceClassResolver->isResourceClass($this->getObjectClass($originalData)));	304✔
94
95	if ($hasData && $this->iriConverter) {	304✔
96	if (
97	!isset($headers['Location'])	184✔
98	&& 300 <= $status && $status < 400	184✔
99	&& (($operation->getExtraProperties()['is_alternate_resource_metadata'] ?? false) \|\| ($operation->getExtraProperties()['canonical_uri_template'] ?? null))	184✔
100	) {
101	$canonicalOperation = $operation;	4✔
102	if ($this->operationMetadataFactory && null !== ($operation->getExtraProperties()['canonical_uri_template'] ?? null)) {	4✔
103	$canonicalOperation = $this->operationMetadataFactory->create($operation->getExtraProperties()['canonical_uri_template'], $context);	4✔
104	}
105
106	$headers['Location'] = $this->iriConverter->getIriFromResource($originalData, UrlGeneratorInterface::ABS_PATH, $canonicalOperation);	4✔
107	} elseif ('PUT' === $method && !$request->attributes->get('previous_data') && null === $status && ($operation instanceof Put && ($operation->getAllowCreate() ?? false))) {	184✔
UNCOV 108	$status = 201;	×
109	}
110	}
111
112	$status ??= self::METHOD_TO_CODE[$method] ?? 200;	304✔
113
114	if ($hasData && $this->iriConverter && !isset($headers['Content-Location'])) {	304✔
115	$iri = $this->iriConverter->getIriFromResource($originalData);	184✔
116	$headers['Content-Location'] = $iri;	184✔
117
118	if ((201 === $status \|\| (300 <= $status && $status < 400)) && 'POST' === $method && !isset($headers['Location'])) {	184✔
119	$headers['Location'] = $iri;	12✔
120	}
121	}
122
123	return new Response(	304✔
124	$data,	304✔
125	$status,	304✔
126	$headers	304✔
127	);	304✔
128	}
129	}

api-platform / core / 9562658349

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