#26133

pending completion

Build # #26133

Build Type

push

github

Committed by

web-flow

Commit Message

<a href="https://github.com/api-platform/core/commit/<a class=hub.com/api-platform/core/commit/922e622fbbb71f806cc5e4a82e0ef4ab7ce5109f">922e622fb<a href="https://github.com/api-platform/core/commit/922e622fbbb71f806cc5e4a82e0ef4ab7ce5109f">">Merge </a><a class="double-link" href="https://github.com/api-platform/core/commit/<a class="double-link" href="https://github.com/api-platform/core/commit/2a6e000708bb378c6d07f82b3f2f266a8fffe193">2a6e00070</a>">2a6e00070</a><a href="https://github.com/api-platform/core/commit/922e622fbbb71f806cc5e4a82e0ef4ab7ce5109f"> into 4bac12859">4bac12859</a>

Run Details

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

8049 of 9543 relevant lines covered (84.34%)

14.97 hits per line

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

80.43

/src/Serializer/SerializerContextBuilder.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\Core\Serializer;

use ApiPlatform\Core\Api\OperationType;
use ApiPlatform\Core\Exception\RuntimeException;
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
use ApiPlatform\Core\Swagger\Serializer\DocumentationNormalizer;
use ApiPlatform\Core\Util\RequestAttributesExtractor;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Serializer\Encoder\CsvEncoder;

/**
 * {@inheritdoc}
 *
 * @author Kévin Dunglas <dunglas@gmail.com>
 */
final class SerializerContextBuilder implements SerializerContextBuilderInterface
{
    private $resourceMetadataFactory;

    public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFactory)
    {
        $this->resourceMetadataFactory = $resourceMetadataFactory;
    }

    /**
     * {@inheritdoc}
     */
    public function createFromRequest(Request $request, bool $normalization, array $attributes = null): array
    {
        if (null === $attributes && !$attributes = RequestAttributesExtractor::extractAttributes($request)) {
            throw new RuntimeException('Request attributes are not valid.');
        }

        $resourceMetadata = $this->resourceMetadataFactory->create($attributes['resource_class']);
        $key = $normalization ? 'normalization_context' : 'denormalization_context';
        if (isset($attributes['collection_operation_name'])) {
            $operationKey = 'collection_operation_name';
            $operationType = OperationType::COLLECTION;
        } elseif (isset($attributes['item_operation_name'])) {
            $operationKey = 'item_operation_name';
            $operationType = OperationType::ITEM;
        } else {
            $operationKey = 'subresource_operation_name';
            $operationType = OperationType::SUBRESOURCE;
        }

        $context = $resourceMetadata->getTypedOperationAttribute($operationType, $attributes[$operationKey], $key, [], true);
        $context['operation_type'] = $operationType;
        $context[$operationKey] = $attributes[$operationKey];

        if (!$normalization) {
            if (!isset($context['api_allow_update'])) {
                $context['api_allow_update'] = \in_array($method = $request->getMethod(), ['PUT', 'PATCH'], true);

                if ($context['api_allow_update'] && 'PATCH' === $method) {
                    $context[AbstractItemNormalizer::DEEP_OBJECT_TO_POPULATE] = $context[AbstractItemNormalizer::DEEP_OBJECT_TO_POPULATE] ?? true;
                }
            }

            if ('csv' === $request->getContentType()) {
                $context[CsvEncoder::AS_COLLECTION_KEY] = false;
            }
        }

        $context['resource_class'] = $attributes['resource_class'];
        $context['input'] = $resourceMetadata->getTypedOperationAttribute($operationType, $attributes[$operationKey], 'input', null, true);
        $context['output'] = $resourceMetadata->getTypedOperationAttribute($operationType, $attributes[$operationKey], 'output', null, true);
        $context['request_uri'] = $request->getRequestUri();
        $context['uri'] = $request->getUri();

        if (isset($attributes['subresource_context'])) {
            $context['subresource_identifiers'] = [];

            foreach ($attributes['subresource_context']['identifiers'] as $key => [$id, $resourceClass]) {
                if (!isset($context['subresource_resources'][$resourceClass])) {
                    $context['subresource_resources'][$resourceClass] = [];
                }

                $context['subresource_identifiers'][$id] = $context['subresource_resources'][$resourceClass][$id] = $request->attributes->get($id);
            }
        }

        if (isset($attributes['subresource_property'])) {
            $context['subresource_property'] = $attributes['subresource_property'];
            $context['subresource_resource_class'] = $attributes['subresource_resource_class'] ?? null;
        }

        unset($context[DocumentationNormalizer::SWAGGER_DEFINITION_NAME]);

        if (isset($context['skip_null_values'])) {
            return $context;
        }

        // TODO: We should always use `skip_null_values` but changing this would be a BC break, for now use it only when `merge-patch+json` is activated on a Resource
        foreach ($resourceMetadata->getItemOperations() as $operation) {
            if ('PATCH' === ($operation['method'] ?? '') && \in_array('application/merge-patch+json', $operation['input_formats']['json'] ?? [], true)) {
                $context[AbstractItemNormalizer::SKIP_NULL_VALUES] = true;

                break;
            }
        }

        return $context;
    }
}

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\Core\Serializer;
15
16	use ApiPlatform\Core\Api\OperationType;
17	use ApiPlatform\Core\Exception\RuntimeException;
18	use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
19	use ApiPlatform\Core\Swagger\Serializer\DocumentationNormalizer;
20	use ApiPlatform\Core\Util\RequestAttributesExtractor;
21	use Symfony\Component\HttpFoundation\Request;
22	use Symfony\Component\Serializer\Encoder\CsvEncoder;
23
24	/**
25	* {@inheritdoc}
26	*
27	* @author Kévin Dunglas <dunglas@gmail.com>
28	*/
29	final class SerializerContextBuilder implements SerializerContextBuilderInterface
30	{
31	private $resourceMetadataFactory;
32
33	public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFactory)
34	{
35	$this->resourceMetadataFactory = $resourceMetadataFactory;	26✔
36	}	26✔
37
38	/**
39	* {@inheritdoc}
40	*/
41	public function createFromRequest(Request $request, bool $normalization, array $attributes = null): array
42	{
43	if (null === $attributes && !$attributes = RequestAttributesExtractor::extractAttributes($request)) {	16✔
44	throw new RuntimeException('Request attributes are not valid.');	1✔
45	}
46
47	$resourceMetadata = $this->resourceMetadataFactory->create($attributes['resource_class']);	15✔
48	$key = $normalization ? 'normalization_context' : 'denormalization_context';	15✔
49	if (isset($attributes['collection_operation_name'])) {	15✔
50	$operationKey = 'collection_operation_name';	12✔
51	$operationType = OperationType::COLLECTION;	12✔
52	} elseif (isset($attributes['item_operation_name'])) {	4✔
53	$operationKey = 'item_operation_name';	4✔
54	$operationType = OperationType::ITEM;	4✔
55	} else {
56	$operationKey = 'subresource_operation_name';	1✔
57	$operationType = OperationType::SUBRESOURCE;	1✔
58	}
59
60	$context = $resourceMetadata->getTypedOperationAttribute($operationType, $attributes[$operationKey], $key, [], true);	15✔
61	$context['operation_type'] = $operationType;	15✔
62	$context[$operationKey] = $attributes[$operationKey];	15✔
63
64	if (!$normalization) {	15✔
65	if (!isset($context['api_allow_update'])) {	6✔
66	$context['api_allow_update'] = \in_array($method = $request->getMethod(), ['PUT', 'PATCH'], true);	6✔
67
68	if ($context['api_allow_update'] && 'PATCH' === $method) {	6✔
69	$context[AbstractItemNormalizer::DEEP_OBJECT_TO_POPULATE] = $context[AbstractItemNormalizer::DEEP_OBJECT_TO_POPULATE] ?? true;	1✔
70	}
71	}
72
73	if ('csv' === $request->getContentType()) {	6✔
74	$context[CsvEncoder::AS_COLLECTION_KEY] = false;	×
75	}
76	}
77
78	$context['resource_class'] = $attributes['resource_class'];	15✔
79	$context['input'] = $resourceMetadata->getTypedOperationAttribute($operationType, $attributes[$operationKey], 'input', null, true);	15✔
80	$context['output'] = $resourceMetadata->getTypedOperationAttribute($operationType, $attributes[$operationKey], 'output', null, true);	15✔
81	$context['request_uri'] = $request->getRequestUri();	15✔
82	$context['uri'] = $request->getUri();	15✔
83
84	if (isset($attributes['subresource_context'])) {	15✔
85	$context['subresource_identifiers'] = [];	×
86
87	foreach ($attributes['subresource_context']['identifiers'] as $key => [$id, $resourceClass]) {	×
88	if (!isset($context['subresource_resources'][$resourceClass])) {	×
89	$context['subresource_resources'][$resourceClass] = [];	×
90	}
91
92	$context['subresource_identifiers'][$id] = $context['subresource_resources'][$resourceClass][$id] = $request->attributes->get($id);	×
93	}
94	}
95
96	if (isset($attributes['subresource_property'])) {	15✔
97	$context['subresource_property'] = $attributes['subresource_property'];	×
98	$context['subresource_resource_class'] = $attributes['subresource_resource_class'] ?? null;	×
99	}
100
101	unset($context[DocumentationNormalizer::SWAGGER_DEFINITION_NAME]);	15✔
102
103	if (isset($context['skip_null_values'])) {	15✔
104	return $context;	×
105	}
106
107	// TODO: We should always use `skip_null_values` but changing this would be a BC break, for now use it only when `merge-patch+json` is activated on a Resource
108	foreach ($resourceMetadata->getItemOperations() as $operation) {	15✔
109	if ('PATCH' === ($operation['method'] ?? '') && \in_array('application/merge-patch+json', $operation['input_formats']['json'] ?? [], true)) {	14✔
110	$context[AbstractItemNormalizer::SKIP_NULL_VALUES] = true;	1✔
111
112	break;	1✔
113	}
114	}
115
116	return $context;	15✔
117	}
118	}

api-platform / core / #26133

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