fix(jsonschema): restore type factory usage (#5897)

fixes #5896

Author: soyuka

phpstan.neon.dist

@@ -26,7 +26,7 @@ parameters:
 		- src/Symfony/Bundle/DependencyInjection/Configuration.php
 		# Templates for Maker
 		- src/Symfony/Maker/Resources/skeleton
-		- src/*/vendor
+		- **vendor**
 	earlyTerminatingMethodCalls:
 		PHPUnit\Framework\Constraint\Constraint:
 			- fail

src/JsonSchema/SchemaFactory.php

@@ -37,15 +37,15 @@ final class SchemaFactory implements SchemaFactoryInterface
 {
     use ResourceClassInfoTrait;
     private array $distinctFormats = [];
-
+    private ?TypeFactoryInterface $typeFactory = 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 FORCE_SUBSCHEMA = '_api_subschema_force_readable_link';
     public const OPENAPI_DEFINITION_NAME = 'openapi_definition_name';
 
     public function __construct(?TypeFactoryInterface $typeFactory, ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory, private readonly PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, private readonly PropertyMetadataFactoryInterface $propertyMetadataFactory, private readonly ?NameConverterInterface $nameConverter = null, ResourceClassResolverInterface $resourceClassResolver = null)
     {
         if ($typeFactory) {
-            trigger_deprecation('api-platform/core', '3.2', sprintf('The "%s" is not needed anymore and will not be used anymore.', TypeFactoryInterface::class));
+            $this->typeFactory = $typeFactory;
         }
 
         $this->resourceMetadataFactory = $resourceMetadataFactory;
@@ -198,6 +198,12 @@ private function buildPropertySchema(Schema $schema, string $definitionName, str
         $subSchema->setDefinitions($schema->getDefinitions()); // Populate definitions of the main schema
 
         foreach ($types as $type) {
+            // TODO: in 3.3 add trigger_deprecation() as type factories are not used anymore, we moved this logic to SchemaPropertyMetadataFactory so that it gets cached
+            if ($typeFromFactory = $this->typeFactory?->getType($type, 'jsonschema', $propertyMetadata->isReadableLink(), $serializerContext)) {
+                $propertySchema = $typeFromFactory;
+                break;
+            }
+
             $isCollection = $type->isCollection();
             if ($isCollection) {
                 $valueType = $type->getCollectionValueTypes()[0] ?? null;

src/JsonSchema/TypeFactory.php

@@ -23,6 +23,8 @@
 /**
  * {@inheritdoc}
  *
+ * @deprecated since 3.3 https://github.com/api-platform/core/pull/5470
+ *
  * @author Kévin Dunglas <[email protected]>
  */
 final class TypeFactory implements TypeFactoryInterface
@@ -46,6 +48,11 @@ public function setSchemaFactory(SchemaFactoryInterface $schemaFactory): void
      */
     public function getType(Type $type, string $format = 'json', bool $readableLink = null, array $serializerContext = null, Schema $schema = null): array
     {
+        if ('jsonschema' === $format) {
+            return [];
+        }
+
+        // TODO: OpenApiFactory uses this to compute filter types
         if ($type->isCollection()) {
             $keyType = $type->getCollectionKeyTypes()[0] ?? null;
             $subType = ($type->getCollectionValueTypes()[0] ?? null) ?? new Type($type->getBuiltinType(), false, $type->getClassName(), false);

src/OpenApi/Factory/OpenApiFactory.php

@@ -573,7 +573,7 @@ private function getFiltersParameters(CollectionOperationInterface|HttpOperation
             }
 
             foreach ($filter->getDescription($entityClass) as $name => $data) {
-                $schema = $data['schema'] ?? (\in_array($data['type'], Type::$builtinTypes, true) ? $this->jsonSchemaTypeFactory->getType(new Type($data['type'], false, null, $data['is_collection'] ?? false)) : ['type' => 'string']);
+                $schema = $data['schema'] ?? (\in_array($data['type'], Type::$builtinTypes, true) ? $this->jsonSchemaTypeFactory->getType(new Type($data['type'], false, null, $data['is_collection'] ?? false), 'openapi') : ['type' => 'string']);
 
                 $parameters[] = new Parameter(
                     $name,

src/Symfony/Bundle/Resources/config/json_schema.xml

@@ -16,7 +16,7 @@
         <service id="ApiPlatform\JsonSchema\TypeFactoryInterface" alias="api_platform.json_schema.type_factory" />
 
         <service id="api_platform.json_schema.schema_factory" class="ApiPlatform\JsonSchema\SchemaFactory">
-            <argument>null</argument>
+            <argument type="service" id="api_platform.json_schema.type_factory" on-invalid="ignore"></argument>
             <argument type="service" id="api_platform.metadata.resource.metadata_collection_factory" />
             <argument type="service" id="api_platform.metadata.property.name_collection_factory" />
             <argument type="service" id="api_platform.metadata.property.metadata_factory" />

tests/Fixtures/TestBundle/ApiResource/Issue5896/Foo.php

@@ -0,0 +1,25 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * 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\Tests\Fixtures\TestBundle\ApiResource\Issue5896;
+
+use ApiPlatform\Metadata\ApiProperty;
+use ApiPlatform\Metadata\Get;
+
+#[Get]
+class Foo
+{
+    #[ApiProperty(readable: false, writable: false, identifier: true)]
+    public ?int $id = null;
+    public ?LocalDate $expiration;
+}

tests/Fixtures/TestBundle/ApiResource/Issue5896/LocalDate.php

@@ -0,0 +1,18 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * 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\Tests\Fixtures\TestBundle\ApiResource\Issue5896;
+
+class LocalDate
+{
+}

tests/Fixtures/TestBundle/ApiResource/Issue5896/TypeFactoryDecorator.php

@@ -0,0 +1,38 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * 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\Tests\Fixtures\TestBundle\ApiResource\Issue5896;
+
+use ApiPlatform\JsonSchema\Schema;
+use ApiPlatform\JsonSchema\TypeFactoryInterface;
+use Symfony\Component\PropertyInfo\Type;
+
+class TypeFactoryDecorator implements TypeFactoryInterface
+{
+    public function __construct(
+        private readonly TypeFactoryInterface $decorated,
+    ) {
+    }
+
+    public function getType(Type $type, string $format = 'json', bool $readableLink = null, array $serializerContext = null, Schema $schema = null): array
+    {
+        if (is_a($type->getClassName(), LocalDate::class, true)) {
+            return [
+                'type' => 'string',
+                'format' => 'date',
+            ];
+        }
+
+        return $this->decorated->getType($type, $format, $readableLink, $serializerContext, $schema);
+    }
+}

tests/Fixtures/app/config/config_common.yml

@@ -457,3 +457,8 @@ services:
     ApiPlatform\Tests\Fixtures\TestBundle\State\ODMLinkHandledDummyLinksHandler:
         tags:
             - {name: 'api_platform.doctrine.odm.links_handler'}
+
+    ApiPlatform\Tests\Fixtures\TestBundle\ApiResource\Issue5896\TypeFactoryDecorator:
+      decorates: 'api_platform.json_schema.type_factory'
+      arguments:
+        $decorated: '@.inner'

tests/JsonSchema/Command/JsonSchemaGenerateCommandTest.php

@@ -124,4 +124,18 @@ public function testArraySchemaWithReference(): void
             '$ref' => '#/definitions/TestEntity.jsonld-write',
         ]);
     }
+
+    /**
+     * TODO: add deprecation (TypeFactory will be deprecated in api platform 3.3).
+     *
+     * @group legacy
+     */
+    public function testArraySchemaWithTypeFactory(): void
+    {
+        $this->tester->run(['command' => 'api:json-schema:generate', 'resource' => 'ApiPlatform\Tests\Fixtures\TestBundle\ApiResource\Issue5896\Foo', '--type' => 'output']);
+        $result = $this->tester->getDisplay();
+        $json = json_decode($result, associative: true);
+
+        $this->assertEquals($json['definitions']['Foo.jsonld']['properties']['expiration'], ['type' => 'string', 'format' => 'date']);
+    }
 }