fix: handle generic array in JsonSchema (#7414)

Co-authored-by: Elliot Bruneel <elliot.bruneel@wizbii.com>

Author: elliotbruneel

src/JsonSchema/SchemaFactory.php

@@ -29,6 +29,7 @@
 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;
 
@@ -349,11 +350,17 @@ private function buildPropertySchema(Schema $schema, string $definitionName, str
  $valueType = TypeHelper::getCollectionValueType($t);
  }
 
- if (!$valueType instanceof ObjectType) {
+ if (!$valueType instanceof ObjectType && !$valueType instanceof GenericType) {
  continue;
  }
 
- $className = $valueType->getClassName();
+ 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;

src/JsonSchema/Tests/Fixtures/GenericChild.php

@@ -0,0 +1,22 @@
+<?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\Tests\Fixtures;
+
+/**
+ * @template T of object
+ */
+class GenericChild
+{
+ public string $property;
+}

src/JsonSchema/Tests/Fixtures/NotAResource.php

@@ -22,11 +22,15 @@
  */
 class NotAResource
 {
+ /**
+ * @param array<GenericChild<object>> $items
+ */
  public function __construct(
  #[Groups('contain_non_resource')]
  private $foo,
  #[Groups('contain_non_resource')]
  private $bar,
+ private array $items,
  ) {
  }
 
@@ -39,4 +43,12 @@ public function getBar()
  {
  return $this->bar;
  }
+
+ /**
+ * @return array<GenericChild<object>>
+ */
+ public function getItems()
+ {
+ return $this->items;
+ }
 }

src/JsonSchema/Tests/SchemaFactoryTest.php

@@ -19,6 +19,7 @@
 use ApiPlatform\JsonSchema\Tests\Fixtures\ApiResource\OverriddenOperationDummy;
 use ApiPlatform\JsonSchema\Tests\Fixtures\DummyResourceInterface;
 use ApiPlatform\JsonSchema\Tests\Fixtures\Enum\GenderTypeEnum;
+use ApiPlatform\JsonSchema\Tests\Fixtures\GenericChild;
 use ApiPlatform\JsonSchema\Tests\Fixtures\NotAResource;
 use ApiPlatform\JsonSchema\Tests\Fixtures\NotAResourceWithUnionIntersectTypes;
 use ApiPlatform\JsonSchema\Tests\Fixtures\Serializable;
@@ -126,7 +127,7 @@ public function testBuildSchemaForNonResourceClass(): void
  $resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataCollectionFactoryInterface::class);
 
  $propertyNameCollectionFactoryProphecy = $this->prophesize(PropertyNameCollectionFactoryInterface::class);
- $propertyNameCollectionFactoryProphecy->create(NotAResource::class, Argument::cetera())->willReturn(new PropertyNameCollection(['foo', 'bar', 'genderType']));
+ $propertyNameCollectionFactoryProphecy->create(NotAResource::class, Argument::cetera())->willReturn(new PropertyNameCollection(['foo', 'bar', 'genderType', 'items']));
 
  $propertyMetadataFactoryProphecy = $this->prophesize(PropertyMetadataFactoryInterface::class);
  $propertyMetadataFactoryProphecy->create(NotAResource::class, 'foo', Argument::cetera())->willReturn(
@@ -150,9 +151,28 @@ public function testBuildSchemaForNonResourceClass(): void
  ->withDefault('male')
  ->withSchema(['type' => 'object', 'default' => 'male', 'example' => 'male'])
  );
+ $propertyMetadataFactoryProphecy->create(NotAResource::class, 'items', Argument::cetera())->willReturn(
+ (new ApiProperty())
+ ->withNativeType(
+ Type::generic(Type::object(GenericChild::class), Type::int()),
+ )
+ ->withReadable(true)
+ ->withSchema(['type' => Schema::UNKNOWN_TYPE])
+ );
+
+ $propertyNameCollectionFactoryProphecy->create(GenericChild::class, Argument::cetera())
+ ->willReturn(new PropertyNameCollection(['property']));
+ $propertyMetadataFactoryProphecy->create(GenericChild::class, 'property', Argument::cetera())
+ ->willReturn(
+ (new ApiProperty())
+ ->withNativeType(Type::string())
+ ->withReadable(true)
+ ->withSchema(['type' => 'string'])
+ );
 
  $resourceClassResolverProphecy = $this->prophesize(ResourceClassResolverInterface::class);
  $resourceClassResolverProphecy->isResourceClass(NotAResource::class)->willReturn(false);
+ $resourceClassResolverProphecy->isResourceClass(GenericChild::class)->willReturn(false);
 
  $definitionNameFactory = new DefinitionNameFactory();
 
@@ -194,6 +214,10 @@ public function testBuildSchemaForNonResourceClass(): void
  $this->assertSame('object', $definitions[$rootDefinitionKey]['properties']['genderType']['type']);
  $this->assertSame('male', $definitions[$rootDefinitionKey]['properties']['genderType']['default']);
  $this->assertSame('male', $definitions[$rootDefinitionKey]['properties']['genderType']['example']);
+
+ $this->assertArrayHasKey('items', $definitions[$rootDefinitionKey]['properties']);
+ $this->assertArrayHasKey('$ref', $definitions[$rootDefinitionKey]['properties']['items']);
+ $this->assertSame('#/definitions/GenericChild', $definitions[$rootDefinitionKey]['properties']['items']['$ref']);
  }
 
  #[IgnoreDeprecations]