fix(jsonschema): do not override nor complete ApiProperty::schema user value (#5855)

* fix(jsonschema): do not override nor complete ApiProperty::schema user value * chore(metadata): improve ExtractorPropertyMetadataFactory

Author: vincentchalamon

src/JsonSchema/Metadata/Property/Factory/SchemaPropertyMetadataFactory.php

@@ -31,6 +31,8 @@ final class SchemaPropertyMetadataFactory implements PropertyMetadataFactoryInte
 {
  use ResourceClassInfoTrait;
 
+ public const JSON_SCHEMA_USER_DEFINED = 'user_defined_schema';
+
  public function __construct(ResourceClassResolverInterface $resourceClassResolver, private readonly ?PropertyMetadataFactoryInterface $decorated = null)
  {
  $this->resourceClassResolver = $resourceClassResolver;
@@ -48,6 +50,13 @@ public function create(string $resourceClass, string $property, array $options =
  }
  }
 
+ $extraProperties = $propertyMetadata->getExtraProperties() ?? [];
+ // see AttributePropertyMetadataFactory
+ if (true === ($extraProperties[self::JSON_SCHEMA_USER_DEFINED] ?? false)) {
+ // schema seems to have been declared by the user: do not override nor complete user value
+ return $propertyMetadata;
+ }
+
  $link = (($options['schema_type'] ?? null) === Schema::TYPE_INPUT) ? $propertyMetadata->isWritableLink() : $propertyMetadata->isReadableLink();
  $propertySchema = $propertyMetadata->getSchema() ?? [];
 

src/Metadata/Property/Factory/AttributePropertyMetadataFactory.php

@@ -13,6 +13,7 @@
 
 namespace ApiPlatform\Metadata\Property\Factory;
 
+use ApiPlatform\JsonSchema\Metadata\Property\Factory\SchemaPropertyMetadataFactory;
 use ApiPlatform\Metadata\ApiProperty;
 use ApiPlatform\Metadata\Exception\PropertyNotFoundException;
 use ApiPlatform\Metadata\Util\Reflection;
@@ -112,7 +113,7 @@ private function handleNotFound(?ApiProperty $parentPropertyMetadata, string $re
  private function createMetadata(ApiProperty $attribute, ApiProperty $propertyMetadata = null): ApiProperty
  {
  if (null === $propertyMetadata) {
- return $attribute;
+ return $this->handleUserDefinedSchema($attribute);
  }
 
  foreach (get_class_methods(ApiProperty::class) as $method) {
@@ -121,6 +122,18 @@ private function createMetadata(ApiProperty $attribute, ApiProperty $propertyMet
  }
  }
 
+ return $this->handleUserDefinedSchema($propertyMetadata);
+ }
+
+ private function handleUserDefinedSchema(ApiProperty $propertyMetadata): ApiProperty
+ {
+ // can't know later if the schema has been defined by the user or by API Platform
+ // store extra key to make this difference
+ if (null !== $propertyMetadata->getSchema()) {
+ $extraProperties = $propertyMetadata->getExtraProperties() ?? [];
+ $propertyMetadata = $propertyMetadata->withExtraProperties([SchemaPropertyMetadataFactory::JSON_SCHEMA_USER_DEFINED => true] + $extraProperties);
+ }
+
  return $propertyMetadata;
  }
 }

src/Metadata/Property/Factory/ExtractorPropertyMetadataFactory.php

@@ -13,6 +13,7 @@
 
 namespace ApiPlatform\Metadata\Property\Factory;
 
+use ApiPlatform\JsonSchema\Metadata\Property\Factory\SchemaPropertyMetadataFactory;
 use ApiPlatform\Metadata\ApiProperty;
 use ApiPlatform\Metadata\Exception\PropertyNotFoundException;
 use ApiPlatform\Metadata\Extractor\PropertyExtractorInterface;
@@ -52,7 +53,7 @@ public function create(string $resourceClass, string $property, array $options =
  }
 
  if ($parentPropertyMetadata) {
- return $this->update($parentPropertyMetadata, $propertyMetadata);
+ return $this->handleUserDefinedSchema($this->update($parentPropertyMetadata, $propertyMetadata));
  }
 
  $apiProperty = new ApiProperty();
@@ -69,7 +70,7 @@ public function create(string $resourceClass, string $property, array $options =
  }
  }
 
- return $apiProperty;
+ return $this->handleUserDefinedSchema($apiProperty);
  }
 
  /**
@@ -91,39 +92,22 @@ private function handleNotFound(?ApiProperty $parentPropertyMetadata, string $re
  */
  private function update(ApiProperty $propertyMetadata, array $metadata): ApiProperty
  {
- $metadataAccessors = [
- 'description' => 'get',
- 'readable' => 'is',
- 'writable' => 'is',
- 'writableLink' => 'is',
- 'readableLink' => 'is',
- 'required' => 'is',
- 'identifier' => 'is',
- 'default' => 'get',
- 'example' => 'get',
- 'deprecationReason' => 'get',
- 'fetchable' => 'is',
- 'fetchEager' => 'get',
- 'jsonldContext' => 'get',
- 'openapiContext' => 'get',
- 'jsonSchemaContext' => 'get',
- 'push' => 'get',
- 'security' => 'get',
- 'securityPostDenormalize' => 'get',
- 'types' => 'get',
- 'builtinTypes' => 'get',
- 'schema' => 'get',
- 'initializable' => 'is',
- 'genId' => 'get',
- 'extraProperties' => 'get',
- ];
-
- foreach ($metadataAccessors as $metadataKey => $accessorPrefix) {
- if (null === $metadata[$metadataKey]) {
- continue;
+ foreach (get_class_methods(ApiProperty::class) as $method) {
+ if (preg_match('/^(?:get|is)(.*)/', (string) $method, $matches) && null !== $val = $metadata[lcfirst($matches[1])]) {
+ $propertyMetadata = $propertyMetadata->{"with{$matches[1]}"}($val);
  }
+ }
 
- $propertyMetadata = $propertyMetadata->{'with'.ucfirst($metadataKey)}($metadata[$metadataKey]);
+ return $propertyMetadata;
+ }
+
+ private function handleUserDefinedSchema(ApiProperty $propertyMetadata): ApiProperty
+ {
+ // can't know later if the schema has been defined by the user or by API Platform
+ // store extra key to make this difference
+ if (null !== $propertyMetadata->getSchema()) {
+ $extraProperties = $propertyMetadata->getExtraProperties() ?? [];
+ $propertyMetadata = $propertyMetadata->withExtraProperties([SchemaPropertyMetadataFactory::JSON_SCHEMA_USER_DEFINED => true] + $extraProperties);
  }
 
  return $propertyMetadata;

src/Metadata/Tests/Extractor/Adapter/XmlPropertyAdapter.php

@@ -145,7 +145,7 @@ private function buildValues(\SimpleXMLElement $resource, array $values): void
  $child = $node->addChild('value');
  $this->buildValues($child, $value);
  } else {
- $child = $node->addChild('value', $value);
+ $child = $node->addChild('value', (string) $value);
  }
  if (\is_string($key)) {
  $child->addAttribute('name', $key);

src/Metadata/Tests/Extractor/Adapter/properties.xml

@@ -1,3 +1,3 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <properties xmlns="https://api-platform.com/schema/metadata/properties-3.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="https://api-platform.com/schema/metadata/properties-3.0 https://api-platform.com/schema/metadata/properties-3.0.xsd">
-<property name="comment" resource="ApiPlatform\Metadata\Tests\Fixtures\ApiResource\Comment" description="Comment message" readable="true" writable="true" readableLink="true" writableLink="true" required="true" identifier="false" default="Plop" example="Lorem ipsum dolor sit amet" deprecationReason="Foo" fetchable="true" fetchEager="true" push="true" security="is_granted('IS_AUTHENTICATED_ANONYMOUSLY')" securityPostDenormalize="is_granted('ROLE_CUSTOM_ADMIN')" initializable="true" genId="true" uriTemplate="/sub-resource-get-collection"><jsonldContext><values><value name="bar"><values><value name="foo"><values><value name="bar">baz</value></values></value></values></value></values></jsonldContext><openapiContext><values><value name="foo">bar</value></values></openapiContext><jsonSchemaContext><values><value name="lorem">ipsum</value></values></jsonSchemaContext><types><type>someirischema</type><type>anotheririschema</type></types><builtinTypes><builtinType>string</builtinType></builtinTypes><schema><values><value>https://schema.org/Thing</value></values></schema><iris><iri>https://schema.org/totalPrice</iri></iris><extraProperties><values><value name="custom_property">Lorem ipsum dolor sit amet</value></values></extraProperties></property></properties>
+<property name="comment" resource="ApiPlatform\Metadata\Tests\Fixtures\ApiResource\Comment" description="Comment message" readable="true" writable="true" readableLink="true" writableLink="true" required="true" identifier="false" default="Plop" example="Lorem ipsum dolor sit amet" deprecationReason="Foo" fetchable="true" fetchEager="true" push="true" security="is_granted('IS_AUTHENTICATED_ANONYMOUSLY')" securityPostDenormalize="is_granted('ROLE_CUSTOM_ADMIN')" initializable="true" genId="true" uriTemplate="/sub-resource-get-collection"><jsonldContext><values><value name="bar"><values><value name="foo"><values><value name="bar">baz</value></values></value></values></value></values></jsonldContext><openapiContext><values><value name="foo">bar</value></values></openapiContext><jsonSchemaContext><values><value name="lorem">ipsum</value></values></jsonSchemaContext><types><type>someirischema</type><type>anotheririschema</type></types><builtinTypes><builtinType>string</builtinType></builtinTypes><schema><values><value>https://schema.org/Thing</value></values></schema><iris><iri>https://schema.org/totalPrice</iri></iris><extraProperties><values><value name="custom_property">Lorem ipsum dolor sit amet</value><value name="user_defined_schema">1</value></values></extraProperties></property></properties>

src/Metadata/Tests/Extractor/Adapter/properties.yaml

@@ -34,6 +34,7 @@ properties:
  initializable: true
  extraProperties:
  custom_property: 'Lorem ipsum dolor sit amet'
+ user_defined_schema: true
  iris:
  - 'https://schema.org/totalPrice'
  genId: true

src/Metadata/Tests/Extractor/PropertyMetadataCompatibilityTest.php

@@ -13,6 +13,7 @@
 
 namespace ApiPlatform\Metadata\Tests\Extractor;
 
+use ApiPlatform\JsonSchema\Metadata\Property\Factory\SchemaPropertyMetadataFactory;
 use ApiPlatform\Metadata\ApiProperty;
 use ApiPlatform\Metadata\Extractor\XmlPropertyExtractor;
 use ApiPlatform\Metadata\Extractor\YamlPropertyExtractor;
@@ -69,6 +70,7 @@ final class PropertyMetadataCompatibilityTest extends TestCase
  'initializable' => true,
  'extraProperties' => [
  'custom_property' => 'Lorem ipsum dolor sit amet',
+ SchemaPropertyMetadataFactory::JSON_SCHEMA_USER_DEFINED => true,
  ],
  'iris' => ['https://schema.org/totalPrice'],
  'genId' => true,

src/Metadata/Tests/Extractor/XmlExtractorTest.php

@@ -358,6 +358,7 @@ public function testValidXML(): void
  ],
  'extraProperties' => [
  'foo' => 'bar',
+ 'boolean' => true,
  ],
  'read' => null,
  'deserialize' => null,

src/Metadata/Tests/Extractor/YamlExtractorTest.php

@@ -382,7 +382,10 @@ public function testValidYaml(): void
  'order' => null,
  'paginationViaCursor' => null,
  'exceptionToStatus' => null,
- 'extraProperties' => null,
+ 'extraProperties' => [
+ 'foo' => 'bar',
+ 'boolean' => true,
+ ],
  'read' => null,
  'deserialize' => null,
  'validate' => null,

src/Metadata/Tests/Extractor/xml/valid.xml

@@ -105,6 +105,7 @@
  <extraProperties>
  <values>
  <value name="foo">bar</value>
+ <value name="boolean">true</value>
  </values>
  </extraProperties>
  </operation>