18042144451

Committed 26 Sep 2025 03:27PM UTC coverage: 21.839% (-0.008%) from 21.847%

Build # 18042144451

Build Type

push

github

Committed by

soyuka

Commit Message

ci: missing apt-update

Run Details

11886 of 54426 relevant lines covered (21.84%)

25.39 hits per line

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

62.56

/src/JsonSchema/SchemaFactory.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\JsonSchema;

use ApiPlatform\JsonSchema\Metadata\Property\Factory\SchemaPropertyMetadataFactory;
use ApiPlatform\Metadata\ApiProperty;
use ApiPlatform\Metadata\CollectionOperationInterface;
use ApiPlatform\Metadata\HttpOperation;
use ApiPlatform\Metadata\Operation;
use ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
use ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
use ApiPlatform\Metadata\ResourceClassResolverInterface;
use ApiPlatform\Metadata\Util\TypeHelper;
use Symfony\Component\PropertyInfo\PropertyInfoExtractor;
use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
use Symfony\Component\Serializer\Normalizer\AbstractNormalizer;
use Symfony\Component\TypeInfo\Type\BuiltinType;
use Symfony\Component\TypeInfo\Type\CollectionType;
use Symfony\Component\TypeInfo\Type\CompositeTypeInterface;
use Symfony\Component\TypeInfo\Type\GenericType;
use Symfony\Component\TypeInfo\Type\ObjectType;
use Symfony\Component\TypeInfo\TypeIdentifier;

/**
 * {@inheritdoc}
 *
 * @author Kévin Dunglas <dunglas@gmail.com>
 */
final class SchemaFactory implements SchemaFactoryInterface, SchemaFactoryAwareInterface
{
    use ResourceMetadataTrait;
    use SchemaUriPrefixTrait;

    private ?SchemaFactoryInterface $schemaFactory = null;
    // Edge case where the related resource is not readable (for example: NotExposed) but we have groups to read the whole related object
    public const OPENAPI_DEFINITION_NAME = 'openapi_definition_name';

    public function __construct(ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory, private readonly PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, private readonly PropertyMetadataFactoryInterface $propertyMetadataFactory, private readonly ?NameConverterInterface $nameConverter = null, ?ResourceClassResolverInterface $resourceClassResolver = null, ?array $distinctFormats = null, private ?DefinitionNameFactoryInterface $definitionNameFactory = null)
    {
        if (!$definitionNameFactory) {
            $this->definitionNameFactory = new DefinitionNameFactory($distinctFormats);
        }

        $this->resourceMetadataFactory = $resourceMetadataFactory;
        $this->resourceClassResolver = $resourceClassResolver;
    }

    /**
     * {@inheritdoc}
     */
    public function buildSchema(string $className, string $format = 'json', string $type = Schema::TYPE_OUTPUT, ?Operation $operation = null, ?Schema $schema = null, ?array $serializerContext = null, bool $forceCollection = false): Schema
    {
        $schema = $schema ? clone $schema : new Schema();

        if (!$this->isResourceClass($className)) {
            $operation = null;
            $inputOrOutputClass = $className;
            $serializerContext ??= [];
        } else {
            $operation = $this->findOperation($className, $type, $operation, $serializerContext, $format);
            $inputOrOutputClass = $this->findOutputClass($className, $type, $operation, $serializerContext);
            $serializerContext ??= $this->getSerializerContext($operation, $type);
        }

        if (null === $inputOrOutputClass) {
            // input or output disabled
            return $schema;
        }

        $validationGroups = $operation ? $this->getValidationGroups($operation) : [];
        $version = $schema->getVersion();
        $definitionName = $this->definitionNameFactory->create($className, $format, $inputOrOutputClass, $operation, $serializerContext);
        $method = $operation instanceof HttpOperation ? $operation->getMethod() : 'GET';
        if (!$operation) {
            $method = Schema::TYPE_INPUT === $type ? 'POST' : 'GET';
        }

        // In case of FORCE_SUBSCHEMA an object can be writable through another class even though it has no POST operation
        if (!($serializerContext[self::FORCE_SUBSCHEMA] ?? false) && Schema::TYPE_OUTPUT !== $type && !\in_array($method, ['POST', 'PATCH', 'PUT'], true)) {
            return $schema;
        }

        if (!isset($schema['$ref']) && !isset($schema['type'])) {
            $ref = $this->getSchemaUriPrefix($version).$definitionName;
            if ($forceCollection || ('POST' !== $method && $operation instanceof CollectionOperationInterface)) {
                $schema['type'] = 'array';
                $schema['items'] = ['$ref' => $ref];
            } else {
                $schema['$ref'] = $ref;
            }
        }

        $definitions = $schema->getDefinitions();
        if (isset($definitions[$definitionName])) {
            // Already computed
            return $schema;
        }

        /** @var \ArrayObject<string, mixed> $definition */
        $definition = new \ArrayObject(['type' => 'object']);
        $definitions[$definitionName] = $definition;
        if ($description = $operation?->getDescription()) {
            $definition['description'] = $description;
        }

        // additionalProperties are allowed by default, so it does not need to be set explicitly, unless allow_extra_attributes is false
        // See https://json-schema.org/understanding-json-schema/reference/object.html#properties
        if (false === ($serializerContext[AbstractNormalizer::ALLOW_EXTRA_ATTRIBUTES] ?? true)) {
            $definition['additionalProperties'] = false;
        }

        // see https://github.com/json-schema-org/json-schema-spec/pull/737
        if (Schema::VERSION_SWAGGER !== $version && $operation && $operation->getDeprecationReason()) {
            $definition['deprecated'] = true;
        }

        // externalDocs is an OpenAPI specific extension, but JSON Schema allows additional keys, so we always add it
        // See https://json-schema.org/latest/json-schema-core.html#rfc.section.6.4
        if ($operation instanceof HttpOperation && ($operation->getTypes()[0] ?? null)) {
            $definition['externalDocs'] = ['url' => $operation->getTypes()[0]];
        }

        $options = ['schema_type' => $type] + $this->getFactoryOptions($serializerContext, $validationGroups, $operation instanceof HttpOperation ? $operation : null);
        foreach ($this->propertyNameCollectionFactory->create($inputOrOutputClass, $options) as $propertyName) {
            $propertyMetadata = $this->propertyMetadataFactory->create($inputOrOutputClass, $propertyName, $options);

            if (false === $propertyMetadata->isReadable() && false === $propertyMetadata->isWritable()) {
                continue;
            }

            $normalizedPropertyName = $this->nameConverter ? $this->nameConverter->normalize($propertyName, $inputOrOutputClass, $format, $serializerContext) : $propertyName;
            if ($propertyMetadata->isRequired()) {
                $definition['required'][] = $normalizedPropertyName;
            }

            if (!method_exists(PropertyInfoExtractor::class, 'getType')) {
                $this->buildLegacyPropertySchema($schema, $definitionName, $normalizedPropertyName, $propertyMetadata, $serializerContext, $format, $type);
            } else {
                $this->buildPropertySchema($schema, $definitionName, $normalizedPropertyName, $propertyMetadata, $serializerContext, $format, $type);
            }
        }

        return $schema;
    }

    /**
     * Builds the JSON Schema for a property using the legacy PropertyInfo component.
     */
    private function buildLegacyPropertySchema(Schema $schema, string $definitionName, string $normalizedPropertyName, ApiProperty $propertyMetadata, array $serializerContext, string $format, string $parentType): void
    {
        $version = $schema->getVersion();
        if (Schema::VERSION_SWAGGER === $version || Schema::VERSION_OPENAPI === $version) {
            $additionalPropertySchema = $propertyMetadata->getOpenapiContext();
        } else {
            $additionalPropertySchema = $propertyMetadata->getJsonSchemaContext();
        }

        $propertySchema = array_merge(
            $propertyMetadata->getSchema() ?? [],
            $additionalPropertySchema ?? []
        );

        // @see https://github.com/api-platform/core/issues/6299
        if (Schema::UNKNOWN_TYPE === ($propertySchema['type'] ?? null) && isset($propertySchema['$ref'])) {
            unset($propertySchema['type']);
        }

        $extraProperties = $propertyMetadata->getExtraProperties();
        // see AttributePropertyMetadataFactory
        if (true === ($extraProperties[SchemaPropertyMetadataFactory::JSON_SCHEMA_USER_DEFINED] ?? false)) {
            // schema seems to have been declared by the user: do not override nor complete user value
            $schema->getDefinitions()[$definitionName]['properties'][$normalizedPropertyName] = new \ArrayObject($propertySchema);

            return;
        }

        $types = $propertyMetadata->getBuiltinTypes() ?? [];

        // never override the following keys if at least one is already set
        // or if property has no type(s) defined
        // or if property schema is already fully defined (type=string + format || enum)
        $propertySchemaType = $propertySchema['type'] ?? false;

        $isUnknown = Schema::UNKNOWN_TYPE === $propertySchemaType
            || ('array' === $propertySchemaType && Schema::UNKNOWN_TYPE === ($propertySchema['items']['type'] ?? null))
            || ('object' === $propertySchemaType && Schema::UNKNOWN_TYPE === ($propertySchema['additionalProperties']['type'] ?? null));

        // Scalar properties
        if (
            !$isUnknown && (
                [] === $types
                || ($propertySchema['$ref'] ?? $propertySchema['anyOf'] ?? $propertySchema['allOf'] ?? $propertySchema['oneOf'] ?? false)
                || (\is_array($propertySchemaType) ? \array_key_exists('string', $propertySchemaType) : 'string' !== $propertySchemaType)
                || ($propertySchema['format'] ?? $propertySchema['enum'] ?? false)
            )
        ) {
            if (isset($propertySchema['$ref'])) {
                unset($propertySchema['type']);
            }

            $schema->getDefinitions()[$definitionName]['properties'][$normalizedPropertyName] = new \ArrayObject($propertySchema);

            return;
        }

        // property schema is created in SchemaPropertyMetadataFactory, but it cannot build resource reference ($ref)
        // complete property schema with resource reference ($ref) only if it's related to an object
        $version = $schema->getVersion();
        $refs = [];
        $isNullable = null;

        foreach ($types as $type) {
            $subSchema = new Schema($version);
            $subSchema->setDefinitions($schema->getDefinitions()); // Populate definitions of the main schema

            $isCollection = $type->isCollection();
            if ($isCollection) {
                $valueType = $type->getCollectionValueTypes()[0] ?? null;
            } else {
                $valueType = $type;
            }

            $className = $valueType?->getClassName();
            if (null === $className) {
                continue;
            }

            $subSchemaFactory = $this->schemaFactory ?: $this;
            $subSchema = $subSchemaFactory->buildSchema($className, $format, $parentType, null, $subSchema, $serializerContext + [self::FORCE_SUBSCHEMA => true], false);
            if (!isset($subSchema['$ref'])) {
                continue;
            }

            if (false === $propertyMetadata->getGenId()) {
                $subDefinitionName = $this->definitionNameFactory->create($className, $format, $className, null, $serializerContext);

                if (isset($subSchema->getDefinitions()[$subDefinitionName])) {
                    // @see https://github.com/api-platform/core/issues/7162
                    // Need to rebuild the definition without @id property and set it back to the sub-schema
                    $subSchemaDefinition = $subSchema->getDefinitions()[$subDefinitionName]->getArrayCopy();
                    unset($subSchemaDefinition['properties']['@id']);
                    $subSchema->getDefinitions()[$subDefinitionName] = new \ArrayObject($subSchemaDefinition);
                }
            }

            if ($isCollection) {
                $key = ($propertySchema['type'] ?? null) === 'object' ? 'additionalProperties' : 'items';
                $propertySchema[$key]['$ref'] = $subSchema['$ref'];
                unset($propertySchema[$key]['type']);
                break;
            }

            $refs[] = ['$ref' => $subSchema['$ref']];
            $isNullable = $isNullable ?? $type->isNullable();
        }

        if ($isNullable) {
            $refs[] = ['type' => 'null'];
        }

        $c = \count($refs);
        if ($c > 1) {
            $propertySchema['anyOf'] = $refs;
            unset($propertySchema['type']);
        } elseif (1 === $c) {
            $propertySchema['$ref'] = $refs[0]['$ref'];
            unset($propertySchema['type']);
        }

        $schema->getDefinitions()[$definitionName]['properties'][$normalizedPropertyName] = new \ArrayObject($propertySchema);
    }

    private function buildPropertySchema(Schema $schema, string $definitionName, string $normalizedPropertyName, ApiProperty $propertyMetadata, array $serializerContext, string $format, string $parentType): void
    {
        $version = $schema->getVersion();
        if (Schema::VERSION_SWAGGER === $version || Schema::VERSION_OPENAPI === $version) {
            $additionalPropertySchema = $propertyMetadata->getOpenapiContext();
        } else {
            $additionalPropertySchema = $propertyMetadata->getJsonSchemaContext();
        }

        $propertySchema = array_merge(
            $propertyMetadata->getSchema() ?? [],
            $additionalPropertySchema ?? []
        );

        $extraProperties = $propertyMetadata->getExtraProperties();
        // see AttributePropertyMetadataFactory
        if (true === ($extraProperties[SchemaPropertyMetadataFactory::JSON_SCHEMA_USER_DEFINED] ?? false)) {
            // schema seems to have been declared by the user: do not override nor complete user value
            $schema->getDefinitions()[$definitionName]['properties'][$normalizedPropertyName] = new \ArrayObject($propertySchema);

            return;
        }

        $type = $propertyMetadata->getNativeType();

        // Type is defined in an allOf, anyOf, or oneOf
        $propertySchemaType = $this->getSchemaValue($propertySchema, 'type');
        $currentRef = $this->getSchemaValue($propertySchema, '$ref');
        $isSchemaDefined = null !== ($currentRef ?? $this->getSchemaValue($propertySchema, 'format') ?? $this->getSchemaValue($propertySchema, 'enum'));
        if (!$isSchemaDefined && Schema::UNKNOWN_TYPE !== $propertySchemaType) {
            $isSchemaDefined = true;
        }

        // Check if the type is considered "unknown" by SchemaPropertyMetadataFactory
        if (isset($propertySchema['additionalProperties']['type']) && Schema::UNKNOWN_TYPE === $propertySchema['additionalProperties']['type']) {
            $isSchemaDefined = false;
        }

        if ($isSchemaDefined && Schema::UNKNOWN_TYPE !== $propertySchemaType) {
            // If schema is defined and not marked as unknown, or if no type info exists, return early
            $schema->getDefinitions()[$definitionName]['properties'][$normalizedPropertyName] = new \ArrayObject($propertySchema);

            return;
        }

        if (Schema::UNKNOWN_TYPE === $propertySchemaType) {
            $propertySchema = [];
        }

        // property schema is created in SchemaPropertyMetadataFactory, but it cannot build resource reference ($ref)
        // complete property schema with resource reference ($ref) if it's related to an object/resource
        $refs = [];
        $isNullable = $type?->isNullable() ?? false;

        // TODO: refactor this with TypeInfo we shouldn't have to loop like this, the below code handles object refs
        if ($type) {
            foreach ($type instanceof CompositeTypeInterface ? $type->getTypes() : [$type] as $t) {
                if ($t instanceof BuiltinType && TypeIdentifier::NULL === $t->getTypeIdentifier()) {
                    continue;
                }

                $valueType = $t;
                $isCollection = $t instanceof CollectionType;

                if ($isCollection) {
                    $valueType = TypeHelper::getCollectionValueType($t);
                }

                if (!$valueType instanceof ObjectType && !$valueType instanceof GenericType) {
                    continue;
                }

                if ($valueType instanceof ObjectType) {
                    $className = $valueType->getClassName();
                } else {
                    // GenericType
                    $className = $valueType->getWrappedType()->getClassName();
                }

                $subSchemaInstance = new Schema($version);
                $subSchemaInstance->setDefinitions($schema->getDefinitions());
                $subSchemaFactory = $this->schemaFactory ?: $this;
                $subSchemaResult = $subSchemaFactory->buildSchema($className, $format, $parentType, null, $subSchemaInstance, $serializerContext + [self::FORCE_SUBSCHEMA => true], false);
                if (!isset($subSchemaResult['$ref'])) {
                    continue;
                }

                if (false === $propertyMetadata->getGenId()) {
                    $subDefinitionName = $this->definitionNameFactory->create($className, $format, $className, null, $serializerContext);
                    if (isset($subSchemaResult->getDefinitions()[$subDefinitionName]['properties']['@id'])) {
                        unset($subSchemaResult->getDefinitions()[$subDefinitionName]['properties']['@id']);
                    }
                }

                if ($isCollection) {
                    $key = ($propertySchema['type'] ?? null) === 'object' ? 'additionalProperties' : 'items';
                    if (!isset($propertySchema['type'])) {
                        $propertySchema['type'] = 'array';
                    }

                    if (!isset($propertySchema[$key]) || !\is_array($propertySchema[$key])) {
                        $propertySchema[$key] = [];
                    }
                    $propertySchema[$key] = ['$ref' => $subSchemaResult['$ref']];
                    $refs = [];
                    break;
                }

                $refs[] = ['$ref' => $subSchemaResult['$ref']];
            }
        }

        if (!empty($refs)) {
            if ($isNullable) {
                $refs[] = ['type' => 'null'];
            }

            if (($c = \count($refs)) > 1) {
                $propertySchema = ['anyOf' => $refs];
            } elseif (1 === $c) {
                $propertySchema = ['$ref' => $refs[0]['$ref']];
            }
        }

        if (null !== $propertyMetadata->getUriTemplate() || (!\array_key_exists('readOnly', $propertySchema) && false === $propertyMetadata->isWritable() && !$propertyMetadata->isInitializable()) && !isset($propertySchema['$ref'])) {
            $propertySchema['readOnly'] = true;
        }

        $schema->getDefinitions()[$definitionName]['properties'][$normalizedPropertyName] = new \ArrayObject($propertySchema);
    }

    private function getValidationGroups(Operation $operation): array
    {
        $groups = $operation->getValidationContext()['groups'] ?? [];

        return \is_array($groups) ? $groups : [$groups];
    }

    /**
     * Gets the options for the property name collection / property metadata factories.
     */
    private function getFactoryOptions(array $serializerContext, array $validationGroups, ?HttpOperation $operation = null): array
    {
        $options = [
            /* @see https://github.com/symfony/symfony/blob/v5.1.0/src/Symfony/Component/PropertyInfo/Extractor/ReflectionExtractor.php */
            'enable_getter_setter_extraction' => true,
        ];

        if (isset($serializerContext[AbstractNormalizer::GROUPS])) {
            /* @see https://github.com/symfony/symfony/blob/v4.2.6/src/Symfony/Component/PropertyInfo/Extractor/SerializerExtractor.php */
            $options['serializer_groups'] = (array) $serializerContext[AbstractNormalizer::GROUPS];
        }

        if ($operation && ($normalizationGroups = $operation->getNormalizationContext()['groups'] ?? null)) {
            $options['normalization_groups'] = $normalizationGroups;
        }

        if ($operation && ($denormalizationGroups = $operation->getDenormalizationContext()['groups'] ?? null)) {
            $options['denormalization_groups'] = $denormalizationGroups;
        }

        if ($validationGroups) {
            $options['validation_groups'] = $validationGroups;
        }

        if ($operation && ($ignoredAttributes = $operation->getNormalizationContext()['ignored_attributes'] ?? null)) {
            $options['ignored_attributes'] = $ignoredAttributes;
        }

        return $options;
    }

    public function setSchemaFactory(SchemaFactoryInterface $schemaFactory): void
    {
        $this->schemaFactory = $schemaFactory;
    }

    private function getSchemaValue(array $schema, string $key): array|string|null
    {
        if (isset($schema['items'])) {
            $schema = $schema['items'];
        }

        return $schema[$key] ?? $schema['allOf'][0][$key] ?? $schema['anyOf'][0][$key] ?? $schema['oneOf'][0][$key] ?? 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\JsonSchema;
15
16	use ApiPlatform\JsonSchema\Metadata\Property\Factory\SchemaPropertyMetadataFactory;
17	use ApiPlatform\Metadata\ApiProperty;
18	use ApiPlatform\Metadata\CollectionOperationInterface;
19	use ApiPlatform\Metadata\HttpOperation;
20	use ApiPlatform\Metadata\Operation;
21	use ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
22	use ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
23	use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
24	use ApiPlatform\Metadata\ResourceClassResolverInterface;
25	use ApiPlatform\Metadata\Util\TypeHelper;
26	use Symfony\Component\PropertyInfo\PropertyInfoExtractor;
27	use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
28	use Symfony\Component\Serializer\Normalizer\AbstractNormalizer;
29	use Symfony\Component\TypeInfo\Type\BuiltinType;
30	use Symfony\Component\TypeInfo\Type\CollectionType;
31	use Symfony\Component\TypeInfo\Type\CompositeTypeInterface;
32	use Symfony\Component\TypeInfo\Type\GenericType;
33	use Symfony\Component\TypeInfo\Type\ObjectType;
34	use Symfony\Component\TypeInfo\TypeIdentifier;
35
36	/**
37	* {@inheritdoc}
38	*
39	* @author Kévin Dunglas <dunglas@gmail.com>
40	*/
41	final class SchemaFactory implements SchemaFactoryInterface, SchemaFactoryAwareInterface
42	{
43	use ResourceMetadataTrait;
44	use SchemaUriPrefixTrait;
45
46	private ?SchemaFactoryInterface $schemaFactory = null;
47	// Edge case where the related resource is not readable (for example: NotExposed) but we have groups to read the whole related object
48	public const OPENAPI_DEFINITION_NAME = 'openapi_definition_name';
49
50	public function __construct(ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory, private readonly PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, private readonly PropertyMetadataFactoryInterface $propertyMetadataFactory, private readonly ?NameConverterInterface $nameConverter = null, ?ResourceClassResolverInterface $resourceClassResolver = null, ?array $distinctFormats = null, private ?DefinitionNameFactoryInterface $definitionNameFactory = null)
51	{
52	if (!$definitionNameFactory) {	697✔
53	$this->definitionNameFactory = new DefinitionNameFactory($distinctFormats);	×
54	}
55
56	$this->resourceMetadataFactory = $resourceMetadataFactory;	697✔
57	$this->resourceClassResolver = $resourceClassResolver;	697✔
58	}
59
60	/**
61	* {@inheritdoc}
62	*/
63	public function buildSchema(string $className, string $format = 'json', string $type = Schema::TYPE_OUTPUT, ?Operation $operation = null, ?Schema $schema = null, ?array $serializerContext = null, bool $forceCollection = false): Schema
64	{
65	$schema = $schema ? clone $schema : new Schema();	116✔
66
67	if (!$this->isResourceClass($className)) {	116✔
68	$operation = null;	54✔
69	$inputOrOutputClass = $className;	54✔
70	$serializerContext ??= [];	54✔
71	} else {
72	$operation = $this->findOperation($className, $type, $operation, $serializerContext, $format);	102✔
73	$inputOrOutputClass = $this->findOutputClass($className, $type, $operation, $serializerContext);	102✔
74	$serializerContext ??= $this->getSerializerContext($operation, $type);	102✔
75	}
76
77	if (null === $inputOrOutputClass) {	116✔
78	// input or output disabled
79	return $schema;	×
80	}
81
82	$validationGroups = $operation ? $this->getValidationGroups($operation) : [];	116✔
83	$version = $schema->getVersion();	116✔
84	$definitionName = $this->definitionNameFactory->create($className, $format, $inputOrOutputClass, $operation, $serializerContext);	116✔
85	$method = $operation instanceof HttpOperation ? $operation->getMethod() : 'GET';	116✔
86	if (!$operation) {	116✔
87	$method = Schema::TYPE_INPUT === $type ? 'POST' : 'GET';	54✔
88	}
89
90	// In case of FORCE_SUBSCHEMA an object can be writable through another class even though it has no POST operation
91	if (!($serializerContext[self::FORCE_SUBSCHEMA] ?? false) && Schema::TYPE_OUTPUT !== $type && !\in_array($method, ['POST', 'PATCH', 'PUT'], true)) {	116✔
92	return $schema;	×
93	}
94
95	if (!isset($schema['$ref']) && !isset($schema['type'])) {	116✔
96	$ref = $this->getSchemaUriPrefix($version).$definitionName;	116✔
97	if ($forceCollection \|\| ('POST' !== $method && $operation instanceof CollectionOperationInterface)) {	116✔
98	$schema['type'] = 'array';	52✔
99	$schema['items'] = ['$ref' => $ref];	52✔
100	} else {
101	$schema['$ref'] = $ref;	106✔
102	}
103	}
104
105	$definitions = $schema->getDefinitions();	116✔
106	if (isset($definitions[$definitionName])) {	116✔
107	// Already computed
108	return $schema;	38✔
109	}
110
111	/** @var \ArrayObject<string, mixed> $definition */
112	$definition = new \ArrayObject(['type' => 'object']);	116✔
113	$definitions[$definitionName] = $definition;	116✔
114	if ($description = $operation?->getDescription()) {	116✔
115	$definition['description'] = $description;	52✔
116	}
117
118	// additionalProperties are allowed by default, so it does not need to be set explicitly, unless allow_extra_attributes is false
119	// See https://json-schema.org/understanding-json-schema/reference/object.html#properties
120	if (false === ($serializerContext[AbstractNormalizer::ALLOW_EXTRA_ATTRIBUTES] ?? true)) {	116✔
121	$definition['additionalProperties'] = false;	×
122	}
123
124	// see https://github.com/json-schema-org/json-schema-spec/pull/737
125	if (Schema::VERSION_SWAGGER !== $version && $operation && $operation->getDeprecationReason()) {	116✔
126	$definition['deprecated'] = true;	×
127	}
128
129	// externalDocs is an OpenAPI specific extension, but JSON Schema allows additional keys, so we always add it
130	// See https://json-schema.org/latest/json-schema-core.html#rfc.section.6.4
131	if ($operation instanceof HttpOperation && ($operation->getTypes()[0] ?? null)) {	116✔
132	$definition['externalDocs'] = ['url' => $operation->getTypes()[0]];	6✔
133	}
134
135	$options = ['schema_type' => $type] + $this->getFactoryOptions($serializerContext, $validationGroups, $operation instanceof HttpOperation ? $operation : null);	116✔
136	foreach ($this->propertyNameCollectionFactory->create($inputOrOutputClass, $options) as $propertyName) {	116✔
137	$propertyMetadata = $this->propertyMetadataFactory->create($inputOrOutputClass, $propertyName, $options);	116✔
138
139	if (false === $propertyMetadata->isReadable() && false === $propertyMetadata->isWritable()) {	116✔
140	continue;	26✔
141	}
142
143	$normalizedPropertyName = $this->nameConverter ? $this->nameConverter->normalize($propertyName, $inputOrOutputClass, $format, $serializerContext) : $propertyName;	116✔
144	if ($propertyMetadata->isRequired()) {	116✔
145	$definition['required'][] = $normalizedPropertyName;	24✔
146	}
147
148	if (!method_exists(PropertyInfoExtractor::class, 'getType')) {	116✔
149	$this->buildLegacyPropertySchema($schema, $definitionName, $normalizedPropertyName, $propertyMetadata, $serializerContext, $format, $type);	×
150	} else {
151	$this->buildPropertySchema($schema, $definitionName, $normalizedPropertyName, $propertyMetadata, $serializerContext, $format, $type);	116✔
152	}
153	}
154
155	return $schema;	116✔
156	}
157
158	/**
159	* Builds the JSON Schema for a property using the legacy PropertyInfo component.
160	*/
161	private function buildLegacyPropertySchema(Schema $schema, string $definitionName, string $normalizedPropertyName, ApiProperty $propertyMetadata, array $serializerContext, string $format, string $parentType): void
162	{
163	$version = $schema->getVersion();	×
164	if (Schema::VERSION_SWAGGER === $version \|\| Schema::VERSION_OPENAPI === $version) {	×
165	$additionalPropertySchema = $propertyMetadata->getOpenapiContext();	×
166	} else {
167	$additionalPropertySchema = $propertyMetadata->getJsonSchemaContext();	×
168	}
169
170	$propertySchema = array_merge(	×
171	$propertyMetadata->getSchema() ?? [],	×
172	$additionalPropertySchema ?? []	×
173	);	×
174
175	// @see https://github.com/api-platform/core/issues/6299
176	if (Schema::UNKNOWN_TYPE === ($propertySchema['type'] ?? null) && isset($propertySchema['$ref'])) {	×
177	unset($propertySchema['type']);	×
178	}
179
180	$extraProperties = $propertyMetadata->getExtraProperties();	×
181	// see AttributePropertyMetadataFactory
182	if (true === ($extraProperties[SchemaPropertyMetadataFactory::JSON_SCHEMA_USER_DEFINED] ?? false)) {	×
183	// schema seems to have been declared by the user: do not override nor complete user value
184	$schema->getDefinitions()[$definitionName]['properties'][$normalizedPropertyName] = new \ArrayObject($propertySchema);	×
185
186	return;	×
187	}
188
189	$types = $propertyMetadata->getBuiltinTypes() ?? [];	×
190
191	// never override the following keys if at least one is already set
192	// or if property has no type(s) defined
193	// or if property schema is already fully defined (type=string + format \|\| enum)
194	$propertySchemaType = $propertySchema['type'] ?? false;	×
195
196	$isUnknown = Schema::UNKNOWN_TYPE === $propertySchemaType	×
197	\|\| ('array' === $propertySchemaType && Schema::UNKNOWN_TYPE === ($propertySchema['items']['type'] ?? null))	×
198	\|\| ('object' === $propertySchemaType && Schema::UNKNOWN_TYPE === ($propertySchema['additionalProperties']['type'] ?? null));	×
199
200	// Scalar properties
201	if (
202	!$isUnknown && (	×
203	[] === $types	×
204	\|\| ($propertySchema['$ref'] ?? $propertySchema['anyOf'] ?? $propertySchema['allOf'] ?? $propertySchema['oneOf'] ?? false)	×
205	\|\| (\is_array($propertySchemaType) ? \array_key_exists('string', $propertySchemaType) : 'string' !== $propertySchemaType)	×
206	\|\| ($propertySchema['format'] ?? $propertySchema['enum'] ?? false)	×
207	)
208	) {
209	if (isset($propertySchema['$ref'])) {	×
210	unset($propertySchema['type']);	×
211	}
212
213	$schema->getDefinitions()[$definitionName]['properties'][$normalizedPropertyName] = new \ArrayObject($propertySchema);	×
214
215	return;	×
216	}
217
218	// property schema is created in SchemaPropertyMetadataFactory, but it cannot build resource reference ($ref)
219	// complete property schema with resource reference ($ref) only if it's related to an object
220	$version = $schema->getVersion();	×
221	$refs = [];	×
222	$isNullable = null;	×
223
224	foreach ($types as $type) {	×
225	$subSchema = new Schema($version);	×
226	$subSchema->setDefinitions($schema->getDefinitions()); // Populate definitions of the main schema	×
227
228	$isCollection = $type->isCollection();	×
229	if ($isCollection) {	×
230	$valueType = $type->getCollectionValueTypes()[0] ?? null;	×
231	} else {
232	$valueType = $type;	×
233	}
234
235	$className = $valueType?->getClassName();	×
236	if (null === $className) {	×
237	continue;	×
238	}
239
240	$subSchemaFactory = $this->schemaFactory ?: $this;	×
241	$subSchema = $subSchemaFactory->buildSchema($className, $format, $parentType, null, $subSchema, $serializerContext + [self::FORCE_SUBSCHEMA => true], false);	×
242	if (!isset($subSchema['$ref'])) {	×
243	continue;	×
244	}
245
246	if (false === $propertyMetadata->getGenId()) {	×
247	$subDefinitionName = $this->definitionNameFactory->create($className, $format, $className, null, $serializerContext);	×
248
249	if (isset($subSchema->getDefinitions()[$subDefinitionName])) {	×
250	// @see https://github.com/api-platform/core/issues/7162
251	// Need to rebuild the definition without @id property and set it back to the sub-schema
252	$subSchemaDefinition = $subSchema->getDefinitions()[$subDefinitionName]->getArrayCopy();	×
253	unset($subSchemaDefinition['properties']['@id']);	×
254	$subSchema->getDefinitions()[$subDefinitionName] = new \ArrayObject($subSchemaDefinition);	×
255	}
256	}
257
258	if ($isCollection) {	×
259	$key = ($propertySchema['type'] ?? null) === 'object' ? 'additionalProperties' : 'items';	×
260	$propertySchema[$key]['$ref'] = $subSchema['$ref'];	×
261	unset($propertySchema[$key]['type']);	×
262	break;	×
263	}
264
265	$refs[] = ['$ref' => $subSchema['$ref']];	×
266	$isNullable = $isNullable ?? $type->isNullable();	×
267	}
268
269	if ($isNullable) {	×
270	$refs[] = ['type' => 'null'];	×
271	}
272
273	$c = \count($refs);	×
274	if ($c > 1) {	×
275	$propertySchema['anyOf'] = $refs;	×
276	unset($propertySchema['type']);	×
277	} elseif (1 === $c) {	×
278	$propertySchema['$ref'] = $refs[0]['$ref'];	×
279	unset($propertySchema['type']);	×
280	}
281
282	$schema->getDefinitions()[$definitionName]['properties'][$normalizedPropertyName] = new \ArrayObject($propertySchema);	×
283	}
284
285	private function buildPropertySchema(Schema $schema, string $definitionName, string $normalizedPropertyName, ApiProperty $propertyMetadata, array $serializerContext, string $format, string $parentType): void
286	{
287	$version = $schema->getVersion();	116✔
288	if (Schema::VERSION_SWAGGER === $version \|\| Schema::VERSION_OPENAPI === $version) {	116✔
289	$additionalPropertySchema = $propertyMetadata->getOpenapiContext();	22✔
290	} else {
291	$additionalPropertySchema = $propertyMetadata->getJsonSchemaContext();	94✔
292	}
293
294	$propertySchema = array_merge(	116✔
295	$propertyMetadata->getSchema() ?? [],	116✔
296	$additionalPropertySchema ?? []	116✔
297	);	116✔
298
299	$extraProperties = $propertyMetadata->getExtraProperties();	116✔
300	// see AttributePropertyMetadataFactory
301	if (true === ($extraProperties[SchemaPropertyMetadataFactory::JSON_SCHEMA_USER_DEFINED] ?? false)) {	116✔
302	// schema seems to have been declared by the user: do not override nor complete user value
303	$schema->getDefinitions()[$definitionName]['properties'][$normalizedPropertyName] = new \ArrayObject($propertySchema);	32✔
304
305	return;	32✔
306	}
307
308	$type = $propertyMetadata->getNativeType();	116✔
309
310	// Type is defined in an allOf, anyOf, or oneOf
311	$propertySchemaType = $this->getSchemaValue($propertySchema, 'type');	116✔
312	$currentRef = $this->getSchemaValue($propertySchema, '$ref');	116✔
313	$isSchemaDefined = null !== ($currentRef ?? $this->getSchemaValue($propertySchema, 'format') ?? $this->getSchemaValue($propertySchema, 'enum'));	116✔
314	if (!$isSchemaDefined && Schema::UNKNOWN_TYPE !== $propertySchemaType) {	116✔
315	$isSchemaDefined = true;	114✔
316	}
317
318	// Check if the type is considered "unknown" by SchemaPropertyMetadataFactory
319	if (isset($propertySchema['additionalProperties']['type']) && Schema::UNKNOWN_TYPE === $propertySchema['additionalProperties']['type']) {	116✔
320	$isSchemaDefined = false;	6✔
321	}
322
323	if ($isSchemaDefined && Schema::UNKNOWN_TYPE !== $propertySchemaType) {	116✔
324	// If schema is defined and not marked as unknown, or if no type info exists, return early
325	$schema->getDefinitions()[$definitionName]['properties'][$normalizedPropertyName] = new \ArrayObject($propertySchema);	116✔
326
327	return;	116✔
328	}
329
330	if (Schema::UNKNOWN_TYPE === $propertySchemaType) {	62✔
331	$propertySchema = [];	62✔
332	}
333
334	// property schema is created in SchemaPropertyMetadataFactory, but it cannot build resource reference ($ref)
335	// complete property schema with resource reference ($ref) if it's related to an object/resource
336	$refs = [];	62✔
337	$isNullable = $type?->isNullable() ?? false;	62✔
338
339	// TODO: refactor this with TypeInfo we shouldn't have to loop like this, the below code handles object refs
340	if ($type) {	62✔
341	foreach ($type instanceof CompositeTypeInterface ? $type->getTypes() : [$type] as $t) {	62✔
342	if ($t instanceof BuiltinType && TypeIdentifier::NULL === $t->getTypeIdentifier()) {	62✔
343	continue;	24✔
344	}
345
346	$valueType = $t;	62✔
347	$isCollection = $t instanceof CollectionType;	62✔
348
349	if ($isCollection) {	62✔
350	$valueType = TypeHelper::getCollectionValueType($t);	38✔
351	}
352
353	if (!$valueType instanceof ObjectType && !$valueType instanceof GenericType) {	62✔
354	continue;	×
355	}
356
357	if ($valueType instanceof ObjectType) {	62✔
358	$className = $valueType->getClassName();	62✔
359	} else {
360	// GenericType
361	$className = $valueType->getWrappedType()->getClassName();	×
362	}
363
364	$subSchemaInstance = new Schema($version);	62✔
365	$subSchemaInstance->setDefinitions($schema->getDefinitions());	62✔
366	$subSchemaFactory = $this->schemaFactory ?: $this;	62✔
367	$subSchemaResult = $subSchemaFactory->buildSchema($className, $format, $parentType, null, $subSchemaInstance, $serializerContext + [self::FORCE_SUBSCHEMA => true], false);	62✔
368	if (!isset($subSchemaResult['$ref'])) {	62✔
369	continue;	×
370	}
371
372	if (false === $propertyMetadata->getGenId()) {	62✔
373	$subDefinitionName = $this->definitionNameFactory->create($className, $format, $className, null, $serializerContext);	2✔
374	if (isset($subSchemaResult->getDefinitions()[$subDefinitionName]['properties']['@id'])) {	2✔
375	unset($subSchemaResult->getDefinitions()[$subDefinitionName]['properties']['@id']);	×
376	}
377	}
378
379	if ($isCollection) {	62✔
380	$key = ($propertySchema['type'] ?? null) === 'object' ? 'additionalProperties' : 'items';	38✔
381	if (!isset($propertySchema['type'])) {	38✔
382	$propertySchema['type'] = 'array';	38✔
383	}
384
385	if (!isset($propertySchema[$key]) \|\| !\is_array($propertySchema[$key])) {	38✔
386	$propertySchema[$key] = [];	38✔
387	}
388	$propertySchema[$key] = ['$ref' => $subSchemaResult['$ref']];	38✔
389	$refs = [];	38✔
390	break;	38✔
391	}
392
393	$refs[] = ['$ref' => $subSchemaResult['$ref']];	46✔
394	}
395	}
396
397	if (!empty($refs)) {	62✔
398	if ($isNullable) {	46✔
399	$refs[] = ['type' => 'null'];	24✔
400	}
401
402	if (($c = \count($refs)) > 1) {	46✔
403	$propertySchema = ['anyOf' => $refs];	26✔
404	} elseif (1 === $c) {	32✔
405	$propertySchema = ['$ref' => $refs[0]['$ref']];	32✔
406	}
407	}
408
409	if (null !== $propertyMetadata->getUriTemplate() \|\| (!\array_key_exists('readOnly', $propertySchema) && false === $propertyMetadata->isWritable() && !$propertyMetadata->isInitializable()) && !isset($propertySchema['$ref'])) {	62✔
410	$propertySchema['readOnly'] = true;	2✔
411	}
412
413	$schema->getDefinitions()[$definitionName]['properties'][$normalizedPropertyName] = new \ArrayObject($propertySchema);	62✔
414	}
415
416	private function getValidationGroups(Operation $operation): array
417	{
418	$groups = $operation->getValidationContext()['groups'] ?? [];	102✔
419
420	return \is_array($groups) ? $groups : [$groups];	102✔
421	}
422
423	/**
424	* Gets the options for the property name collection / property metadata factories.
425	*/
426	private function getFactoryOptions(array $serializerContext, array $validationGroups, ?HttpOperation $operation = null): array
427	{
428	$options = [	116✔
429	/* @see https://github.com/symfony/symfony/blob/v5.1.0/src/Symfony/Component/PropertyInfo/Extractor/ReflectionExtractor.php */
430	'enable_getter_setter_extraction' => true,	116✔
431	];	116✔
432
433	if (isset($serializerContext[AbstractNormalizer::GROUPS])) {	116✔
434	/* @see https://github.com/symfony/symfony/blob/v4.2.6/src/Symfony/Component/PropertyInfo/Extractor/SerializerExtractor.php */
435	$options['serializer_groups'] = (array) $serializerContext[AbstractNormalizer::GROUPS];	42✔
436	}
437
438	if ($operation && ($normalizationGroups = $operation->getNormalizationContext()['groups'] ?? null)) {	116✔
439	$options['normalization_groups'] = $normalizationGroups;	44✔
440	}
441
442	if ($operation && ($denormalizationGroups = $operation->getDenormalizationContext()['groups'] ?? null)) {	116✔
443	$options['denormalization_groups'] = $denormalizationGroups;	14✔
444	}
445
446	if ($validationGroups) {	116✔
447	$options['validation_groups'] = $validationGroups;	×
448	}
449
450	if ($operation && ($ignoredAttributes = $operation->getNormalizationContext()['ignored_attributes'] ?? null)) {	116✔
451	$options['ignored_attributes'] = $ignoredAttributes;	30✔
452	}
453
454	return $options;	116✔
455	}
456
457	public function setSchemaFactory(SchemaFactoryInterface $schemaFactory): void
458	{
459	$this->schemaFactory = $schemaFactory;	697✔
460	}
461
462	private function getSchemaValue(array $schema, string $key): array\|string\|null
463	{
464	if (isset($schema['items'])) {	116✔
465	$schema = $schema['items'];	72✔
466	}
467
468	return $schema[$key] ?? $schema['allOf'][0][$key] ?? $schema['anyOf'][0][$key] ?? $schema['oneOf'][0][$key] ?? null;	116✔
469	}
470	}

api-platform / core / 18042144451

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