14516256486

Committed 17 Apr 2025 01:00PM UTC coverage: 6.974% (-1.6%) from 8.532%

Build # 14516256486

Build Type

push

github

Committed by

web-flow

Commit Message

feat(hydra): use `TypeInfo`'s `Type` (#7099)

Co-authored-by: Mathias Arlaud <mathias.arlaud@gmail.com>

Run Details

40 of 95 new or added lines in 2 files covered. (42.11%)

399 existing lines in 8 files now uncovered.

11059 of 158579 relevant lines covered (6.97%)

6.2 hits per line

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

0.0

/src/Elasticsearch/Util/FieldDatatypeTrait.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\Elasticsearch\Util;

use ApiPlatform\Metadata\Exception\PropertyNotFoundException;
use ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
use ApiPlatform\Metadata\ResourceClassResolverInterface;
use Symfony\Component\PropertyInfo\PropertyInfoExtractor;
use Symfony\Component\PropertyInfo\Type as LegacyType;
use Symfony\Component\TypeInfo\Type;
use Symfony\Component\TypeInfo\Type\CollectionType;
use Symfony\Component\TypeInfo\Type\CompositeTypeInterface;
use Symfony\Component\TypeInfo\Type\ObjectType;
use Symfony\Component\TypeInfo\Type\WrappingTypeInterface;

/**
 * Field datatypes helpers.
 *
 * @internal
 *
 * @experimental
 *
 * @author Baptiste Meyer <baptiste.meyer@gmail.com>
 */
trait FieldDatatypeTrait
{
    private readonly PropertyMetadataFactoryInterface $propertyMetadataFactory;

    private readonly ResourceClassResolverInterface $resourceClassResolver;

    /**
     * Is the decomposed given property of the given resource class potentially mapped as a nested field in Elasticsearch?
     */
    private function isNestedField(string $resourceClass, string $property): bool
    {
        return null !== $this->getNestedFieldPath($resourceClass, $property);
    }

    /**
     * Get the nested path to the decomposed given property (e.g.: foo.bar.baz => foo.bar).
     *
     * Elasticsearch can save arrays of Objects as nested documents.
     * In the case of foo.bar.baz
     *   foo.bar will be returned if foo.bar is an array of objects.
     *   If neither foo nor bar is an array, it is not a nested property and will return null.
     */
    private function getNestedFieldPath(string $resourceClass, string $property): ?string
    {
        $properties = explode('.', $property);
        $currentProperty = array_shift($properties);

        if (!$properties) {
            return null;
        }

        try {
            $propertyMetadata = $this->propertyMetadataFactory->create($resourceClass, $currentProperty);
        } catch (PropertyNotFoundException) {
            return null;
        }

        if (!method_exists(PropertyInfoExtractor::class, 'getType')) {
            $types = $propertyMetadata->getBuiltinTypes() ?? [];

            foreach ($types as $type) {
                if (
                    LegacyType::BUILTIN_TYPE_OBJECT === $type->getBuiltinType()
                    && null !== ($nextResourceClass = $type->getClassName())
                    && $this->resourceClassResolver->isResourceClass($nextResourceClass)
                ) {
                    $nestedPath = $this->getNestedFieldPath($nextResourceClass, implode('.', $properties));

                    return null === $nestedPath ? $nestedPath : "$currentProperty.$nestedPath";
                }

                if (
                    null !== ($type = $type->getCollectionValueTypes()[0] ?? null)
                    && LegacyType::BUILTIN_TYPE_OBJECT === $type->getBuiltinType()
                    && null !== ($className = $type->getClassName())
                    && $this->resourceClassResolver->isResourceClass($className)
                ) {
                    $nestedPath = $this->getNestedFieldPath($className, implode('.', $properties));

                    return null === $nestedPath ? $currentProperty : "$currentProperty.$nestedPath";
                }
            }

            return null;
        }

        $type = $propertyMetadata->getNativeType();

        if (null === $type) {
            return null;
        }

        /** @var class-string|null $className */
        $className = null;

        $typeIsResourceClass = function (Type $type) use (&$typeIsResourceClass, &$className): bool {
            return match (true) {
                $type instanceof WrappingTypeInterface => $type->wrappedTypeIsSatisfiedBy($typeIsResourceClass),
                $type instanceof CompositeTypeInterface => $type->composedTypesAreSatisfiedBy($typeIsResourceClass),
                $type instanceof ObjectType => $this->resourceClassResolver->isResourceClass($className = $type->getClassName()),
                default => false,
            };
        };

        if ($type->isSatisfiedBy($typeIsResourceClass)) {
            $nestedPath = $this->getNestedFieldPath($className, implode('.', $properties));

            return null === $nestedPath ? $nestedPath : "$currentProperty.$nestedPath";
        }

        $collectionValueTypeIsResourceClass = function (Type $type) use (&$collectionValueTypeIsResourceClass, &$className): bool {
            return match (true) {
                $type instanceof CollectionType => $type->getCollectionValueType() instanceof ObjectType && $this->resourceClassResolver->isResourceClass($className = $type->getCollectionValueType()->getClassName()),
                $type instanceof WrappingTypeInterface => $type->wrappedTypeIsSatisfiedBy($collectionValueTypeIsResourceClass),
                $type instanceof CompositeTypeInterface => $type->composedTypesAreSatisfiedBy($collectionValueTypeIsResourceClass),
                default => false,
            };
        };

        if ($type->isSatisfiedBy($collectionValueTypeIsResourceClass)) {
            $nestedPath = $this->getNestedFieldPath($className, implode('.', $properties));

            return null === $nestedPath ? $currentProperty : "$currentProperty.$nestedPath";
        }

        return null;
    }
}

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\Elasticsearch\Util;
15
16	use ApiPlatform\Metadata\Exception\PropertyNotFoundException;
17	use ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
18	use ApiPlatform\Metadata\ResourceClassResolverInterface;
19	use Symfony\Component\PropertyInfo\PropertyInfoExtractor;
20	use Symfony\Component\PropertyInfo\Type as LegacyType;
21	use Symfony\Component\TypeInfo\Type;
22	use Symfony\Component\TypeInfo\Type\CollectionType;
23	use Symfony\Component\TypeInfo\Type\CompositeTypeInterface;
24	use Symfony\Component\TypeInfo\Type\ObjectType;
25	use Symfony\Component\TypeInfo\Type\WrappingTypeInterface;
26
27	/**
28	* Field datatypes helpers.
29	*
30	* @internal
31	*
32	* @experimental
33	*
34	* @author Baptiste Meyer <baptiste.meyer@gmail.com>
35	*/
36	trait FieldDatatypeTrait
37	{
38	private readonly PropertyMetadataFactoryInterface $propertyMetadataFactory;
39
40	private readonly ResourceClassResolverInterface $resourceClassResolver;
41
42	/**
43	* Is the decomposed given property of the given resource class potentially mapped as a nested field in Elasticsearch?
44	*/
45	private function isNestedField(string $resourceClass, string $property): bool
46	{
UNCOV 47	return null !== $this->getNestedFieldPath($resourceClass, $property);	×
48	}
49
50	/**
51	* Get the nested path to the decomposed given property (e.g.: foo.bar.baz => foo.bar).
52	*
53	* Elasticsearch can save arrays of Objects as nested documents.
54	* In the case of foo.bar.baz
55	* foo.bar will be returned if foo.bar is an array of objects.
56	* If neither foo nor bar is an array, it is not a nested property and will return null.
57	*/
58	private function getNestedFieldPath(string $resourceClass, string $property): ?string
59	{
UNCOV 60	$properties = explode('.', $property);	×
UNCOV 61	$currentProperty = array_shift($properties);	×
62
63	if (!$properties) {	×
64	return null;	×
65	}
66
67	try {
UNCOV 68	$propertyMetadata = $this->propertyMetadataFactory->create($resourceClass, $currentProperty);	×
69	} catch (PropertyNotFoundException) {	×
UNCOV 70	return null;	×
71	}
72
73	if (!method_exists(PropertyInfoExtractor::class, 'getType')) {	×
UNCOV 74	$types = $propertyMetadata->getBuiltinTypes() ?? [];	×
75
UNCOV 76	foreach ($types as $type) {	×
77	if (
UNCOV 78	LegacyType::BUILTIN_TYPE_OBJECT === $type->getBuiltinType()	×
UNCOV 79	&& null !== ($nextResourceClass = $type->getClassName())	×
UNCOV 80	&& $this->resourceClassResolver->isResourceClass($nextResourceClass)	×
81	) {
82	$nestedPath = $this->getNestedFieldPath($nextResourceClass, implode('.', $properties));	×
83
84	return null === $nestedPath ? $nestedPath : "$currentProperty.$nestedPath";	×
85	}
86
87	if (
88	null !== ($type = $type->getCollectionValueTypes()[0] ?? null)	×
UNCOV 89	&& LegacyType::BUILTIN_TYPE_OBJECT === $type->getBuiltinType()	×
UNCOV 90	&& null !== ($className = $type->getClassName())	×
UNCOV 91	&& $this->resourceClassResolver->isResourceClass($className)	×
92	) {
UNCOV 93	$nestedPath = $this->getNestedFieldPath($className, implode('.', $properties));	×
94
UNCOV 95	return null === $nestedPath ? $currentProperty : "$currentProperty.$nestedPath";	×
96	}
97	}
98
UNCOV 99	return null;	×
100	}
101
UNCOV 102	$type = $propertyMetadata->getNativeType();	×
103
UNCOV 104	if (null === $type) {	×
UNCOV 105	return null;	×
106	}
107
108	/** @var class-string\|null $className */
UNCOV 109	$className = null;	×
110
UNCOV 111	$typeIsResourceClass = function (Type $type) use (&$typeIsResourceClass, &$className): bool {	×
UNCOV 112	return match (true) {	×
UNCOV 113	$type instanceof WrappingTypeInterface => $type->wrappedTypeIsSatisfiedBy($typeIsResourceClass),	×
UNCOV 114	$type instanceof CompositeTypeInterface => $type->composedTypesAreSatisfiedBy($typeIsResourceClass),	×
UNCOV 115	$type instanceof ObjectType => $this->resourceClassResolver->isResourceClass($className = $type->getClassName()),	×
UNCOV 116	default => false,	×
UNCOV 117	};	×
UNCOV 118	};	×
119
UNCOV 120	if ($type->isSatisfiedBy($typeIsResourceClass)) {	×
UNCOV 121	$nestedPath = $this->getNestedFieldPath($className, implode('.', $properties));	×
122
UNCOV 123	return null === $nestedPath ? $nestedPath : "$currentProperty.$nestedPath";	×
124	}
125
UNCOV 126	$collectionValueTypeIsResourceClass = function (Type $type) use (&$collectionValueTypeIsResourceClass, &$className): bool {	×
UNCOV 127	return match (true) {	×
UNCOV 128	$type instanceof CollectionType => $type->getCollectionValueType() instanceof ObjectType && $this->resourceClassResolver->isResourceClass($className = $type->getCollectionValueType()->getClassName()),	×
UNCOV 129	$type instanceof WrappingTypeInterface => $type->wrappedTypeIsSatisfiedBy($collectionValueTypeIsResourceClass),	×
UNCOV 130	$type instanceof CompositeTypeInterface => $type->composedTypesAreSatisfiedBy($collectionValueTypeIsResourceClass),	×
UNCOV 131	default => false,	×
UNCOV 132	};	×
UNCOV 133	};	×
134
UNCOV 135	if ($type->isSatisfiedBy($collectionValueTypeIsResourceClass)) {	×
UNCOV 136	$nestedPath = $this->getNestedFieldPath($className, implode('.', $properties));	×
137
UNCOV 138	return null === $nestedPath ? $currentProperty : "$currentProperty.$nestedPath";	×
139	}
140
UNCOV 141	return null;	×
142	}
143	}

api-platform / core / 14516256486

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