20894952430

Committed 11 Jan 2026 12:14PM UTC coverage: 20.145% (-8.7%) from 28.875%

Build # 20894952430

Build Type

Pull #7667

github

Committed by

VincentLanglet

Commit Message

Add failing test

Pull Request Pull Request #7667: POC NameConverterAwareInterface

Run Details

11577 of 57467 relevant lines covered (20.15%)

27.48 hits per line

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

97.44

/src/GraphQl/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\GraphQl\Serializer;

use ApiPlatform\Metadata\GraphQl\Mutation;
use ApiPlatform\Metadata\GraphQl\Operation;
use ApiPlatform\Metadata\GraphQl\Subscription;
use GraphQL\Type\Definition\ResolveInfo;
use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
use Symfony\Component\Serializer\Normalizer\AbstractObjectNormalizer;

/**
 * Builds the context used by the Symfony Serializer.
 *
 * @author Alan Poulain <contact@alanpoulain.eu>
 */
final class SerializerContextBuilder implements SerializerContextBuilderInterface
{
    public function __construct(private readonly ?NameConverterInterface $nameConverter)
    {
    }

    public function create(?string $resourceClass, Operation $operation, array $resolverContext, bool $normalization): array
    {
        $context = ['resource_class' => $resourceClass, 'operation_name' => $operation->getName(), 'graphql_operation_name' => $operation->getName()];

        if (isset($resolverContext['fields'])) {
            $context['no_resolver_data'] = true;
        }

        $context['operation'] = $operation;
        if ($operation->getInput()) {
            $context['input'] = $operation->getInput();
        }
        if ($operation->getOutput()) {
            $context['output'] = $operation->getOutput();
        }
        $context = $normalization ? array_merge($operation->getNormalizationContext() ?? [], $context) : array_merge($operation->getDenormalizationContext() ?? [], $context);

        if ($normalization) {
            $context['attributes'] = $this->fieldsToAttributes($resourceClass, $operation, $resolverContext, $context);
        }

        // to keep the cache computation smaller, we have "operation_name" and "iri" anyways
        $context[AbstractObjectNormalizer::EXCLUDE_FROM_CACHE_KEY][] = 'root_operation';
        $context[AbstractObjectNormalizer::EXCLUDE_FROM_CACHE_KEY][] = 'operation';
        $context[AbstractObjectNormalizer::EXCLUDE_FROM_CACHE_KEY][] = 'object';
        $context[AbstractObjectNormalizer::EXCLUDE_FROM_CACHE_KEY][] = 'data';
        $context[AbstractObjectNormalizer::EXCLUDE_FROM_CACHE_KEY][] = 'property_metadata';
        $context[AbstractObjectNormalizer::EXCLUDE_FROM_CACHE_KEY][] = 'circular_reference_limit_counters';
        $context[AbstractObjectNormalizer::EXCLUDE_FROM_CACHE_KEY][] = 'debug_trace_id';

        return $context;
    }

    /**
     * Retrieves fields, recursively replaces the "_id" key (the raw id) by "id" (the name of the property expected by the Serializer) and flattens edge and node structures (pagination).
     */
    private function fieldsToAttributes(?string $resourceClass, Operation $operation, array $resolverContext, array $context): array
    {
        if (isset($resolverContext['fields'])) {
            $fields = $resolverContext['fields'];
        } else {
            /** @var ResolveInfo $info */
            $info = $resolverContext['info'];
            $fields = $info->getFieldSelection(\PHP_INT_MAX);
        }

        $attributes = $this->replaceIdKeys($fields['edges']['node'] ?? $fields['collection'] ?? $fields, $resourceClass, $context);

        if ($operation instanceof Subscription || $operation instanceof Mutation) {
            $wrapFieldName = lcfirst($operation->getShortName());

            return $attributes[$wrapFieldName] ?? [];
        }

        return $attributes;
    }

    private function replaceIdKeys(array $fields, ?string $resourceClass, array $context): array
    {
        $denormalizedFields = [];

        foreach ($fields as $key => $value) {
            if ('_id' === $key) {
                $denormalizedFields['id'] = $fields['_id'];

                continue;
            }

            $denormalizedFields[$this->denormalizePropertyName((string) $key, $resourceClass, $context)] = \is_array($value) ? $this->replaceIdKeys($value, $resourceClass, $context) : $value;
        }

        return $denormalizedFields;
    }

    private function denormalizePropertyName(string $property, ?string $resourceClass, array $context): string
    {
        if (null === $this->nameConverter) {
            return $property;
        }

        return $this->nameConverter->denormalize($property, $resourceClass, null, $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\GraphQl\Serializer;
15
16	use ApiPlatform\Metadata\GraphQl\Mutation;
17	use ApiPlatform\Metadata\GraphQl\Operation;
18	use ApiPlatform\Metadata\GraphQl\Subscription;
19	use GraphQL\Type\Definition\ResolveInfo;
20	use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
21	use Symfony\Component\Serializer\Normalizer\AbstractObjectNormalizer;
22
23	/**
24	* Builds the context used by the Symfony Serializer.
25	*
26	* @author Alan Poulain <contact@alanpoulain.eu>
27	*/
28	final class SerializerContextBuilder implements SerializerContextBuilderInterface
29	{
30	public function __construct(private readonly ?NameConverterInterface $nameConverter)
31	{
32	}	495✔
33
34	public function create(?string $resourceClass, Operation $operation, array $resolverContext, bool $normalization): array
35	{
36	$context = ['resource_class' => $resourceClass, 'operation_name' => $operation->getName(), 'graphql_operation_name' => $operation->getName()];	121✔
37
38	if (isset($resolverContext['fields'])) {	121✔
39	$context['no_resolver_data'] = true;	1✔
40	}
41
42	$context['operation'] = $operation;	121✔
43	if ($operation->getInput()) {	121✔
44	$context['input'] = $operation->getInput();	5✔
45	}
46	if ($operation->getOutput()) {	121✔
47	$context['output'] = $operation->getOutput();	4✔
48	}
49	$context = $normalization ? array_merge($operation->getNormalizationContext() ?? [], $context) : array_merge($operation->getDenormalizationContext() ?? [], $context);	121✔
50
51	if ($normalization) {	121✔
52	$context['attributes'] = $this->fieldsToAttributes($resourceClass, $operation, $resolverContext, $context);	121✔
53	}
54
55	// to keep the cache computation smaller, we have "operation_name" and "iri" anyways
56	$context[AbstractObjectNormalizer::EXCLUDE_FROM_CACHE_KEY][] = 'root_operation';	121✔
57	$context[AbstractObjectNormalizer::EXCLUDE_FROM_CACHE_KEY][] = 'operation';	121✔
58	$context[AbstractObjectNormalizer::EXCLUDE_FROM_CACHE_KEY][] = 'object';	121✔
59	$context[AbstractObjectNormalizer::EXCLUDE_FROM_CACHE_KEY][] = 'data';	121✔
60	$context[AbstractObjectNormalizer::EXCLUDE_FROM_CACHE_KEY][] = 'property_metadata';	121✔
61	$context[AbstractObjectNormalizer::EXCLUDE_FROM_CACHE_KEY][] = 'circular_reference_limit_counters';	121✔
62	$context[AbstractObjectNormalizer::EXCLUDE_FROM_CACHE_KEY][] = 'debug_trace_id';	121✔
63
64	return $context;	121✔
65	}
66
67	/**
68	* Retrieves fields, recursively replaces the "_id" key (the raw id) by "id" (the name of the property expected by the Serializer) and flattens edge and node structures (pagination).
69	*/
70	private function fieldsToAttributes(?string $resourceClass, Operation $operation, array $resolverContext, array $context): array
71	{
72	if (isset($resolverContext['fields'])) {	121✔
73	$fields = $resolverContext['fields'];	1✔
74	} else {
75	/** @var ResolveInfo $info */
76	$info = $resolverContext['info'];	120✔
77	$fields = $info->getFieldSelection(\PHP_INT_MAX);	120✔
78	}
79
80	$attributes = $this->replaceIdKeys($fields['edges']['node'] ?? $fields['collection'] ?? $fields, $resourceClass, $context);	121✔
81
82	if ($operation instanceof Subscription \|\| $operation instanceof Mutation) {	121✔
83	$wrapFieldName = lcfirst($operation->getShortName());	40✔
84
85	return $attributes[$wrapFieldName] ?? [];	40✔
86	}
87
88	return $attributes;	88✔
89	}
90
91	private function replaceIdKeys(array $fields, ?string $resourceClass, array $context): array
92	{
93	$denormalizedFields = [];	121✔
94
95	foreach ($fields as $key => $value) {	121✔
96	if ('_id' === $key) {	121✔
97	$denormalizedFields['id'] = $fields['_id'];	5✔
98
99	continue;	5✔
100	}
101
102	$denormalizedFields[$this->denormalizePropertyName((string) $key, $resourceClass, $context)] = \is_array($value) ? $this->replaceIdKeys($value, $resourceClass, $context) : $value;	120✔
103	}
104
105	return $denormalizedFields;	121✔
106	}
107
108	private function denormalizePropertyName(string $property, ?string $resourceClass, array $context): string
109	{
110	if (null === $this->nameConverter) {	120✔
111	return $property;	×
112	}
113
114	return $this->nameConverter->denormalize($property, $resourceClass, null, $context);	120✔
115	}
116	}

api-platform / core / 20894952430

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