fix(jsonschema): keep format subschema generation (#6055)

fixes #5950

Author: soyuka

src/Hal/JsonSchema/SchemaFactory.php

@@ -14,6 +14,7 @@
 namespace ApiPlatform\Hal\JsonSchema;
 
 use ApiPlatform\JsonSchema\Schema;
+use ApiPlatform\JsonSchema\SchemaFactoryAwareInterface;
 use ApiPlatform\JsonSchema\SchemaFactoryInterface;
 use ApiPlatform\Metadata\Operation;
 
@@ -46,6 +47,9 @@ final class SchemaFactory implements SchemaFactoryInterface
     public function __construct(private readonly SchemaFactoryInterface $schemaFactory)
     {
         $this->addDistinctFormat('jsonhal');
+        if ($this->schemaFactory instanceof SchemaFactoryAwareInterface) {
+            $this->schemaFactory->setSchemaFactory($this);
+        }
     }
 
     /**

src/Hydra/JsonSchema/SchemaFactory.php

@@ -16,6 +16,7 @@
 use ApiPlatform\JsonLd\ContextBuilder;
 use ApiPlatform\JsonSchema\Schema;
 use ApiPlatform\JsonSchema\SchemaFactory as BaseSchemaFactory;
+use ApiPlatform\JsonSchema\SchemaFactoryAwareInterface;
 use ApiPlatform\JsonSchema\SchemaFactoryInterface;
 use ApiPlatform\Metadata\Operation;
 
@@ -60,6 +61,9 @@ final class SchemaFactory implements SchemaFactoryInterface
     public function __construct(private readonly SchemaFactoryInterface $schemaFactory)
     {
         $this->addDistinctFormat('jsonld');
+        if ($this->schemaFactory instanceof SchemaFactoryAwareInterface) {
+            $this->schemaFactory->setSchemaFactory($this);
+        }
     }
 
     /**

src/JsonSchema/SchemaFactory.php

@@ -33,11 +33,12 @@
  *
  * @author Kévin Dunglas <[email protected]>
  */
-final class SchemaFactory implements SchemaFactoryInterface
+final class SchemaFactory implements SchemaFactoryInterface, SchemaFactoryAwareInterface
 {
     use ResourceClassInfoTrait;
     private array $distinctFormats = [];
     private ?TypeFactoryInterface $typeFactory = null;
+    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 FORCE_SUBSCHEMA = '_api_subschema_force_readable_link';
     public const OPENAPI_DEFINITION_NAME = 'openapi_definition_name';
@@ -217,7 +218,8 @@ private function buildPropertySchema(Schema $schema, string $definitionName, str
                 continue;
             }
 
-            $subSchema = $this->buildSchema($className, $format, $parentType, null, $subSchema, $serializerContext + [self::FORCE_SUBSCHEMA => true], false);
+            $subSchemaFactory = $this->schemaFactory ?: $this;
+            $subSchema = $subSchemaFactory->buildSchema($className, $format, $parentType, null, $subSchema, $serializerContext + [self::FORCE_SUBSCHEMA => true], false);
             if (!isset($subSchema['$ref'])) {
                 continue;
             }
@@ -399,4 +401,9 @@ private function getShortClassName(string $fullyQualifiedName): string
 
         return end($parts);
     }
+
+    public function setSchemaFactory(SchemaFactoryInterface $schemaFactory): void
+    {
+        $this->schemaFactory = $schemaFactory;
+    }
 }

src/JsonSchema/SchemaFactoryAwareInterface.php

@@ -0,0 +1,19 @@
+<?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\JsonSchema;
+
+interface SchemaFactoryAwareInterface
+{
+    public function setSchemaFactory(SchemaFactoryInterface $schemaFactory): void;
+}

tests/JsonSchema/Command/JsonSchemaGenerateCommandTest.php

@@ -150,4 +150,16 @@ public function testWritableNonResourceRef(): void
 
         $this->assertEquals($json['definitions']['SaveProduct.jsonld']['properties']['codes']['items']['$ref'], '#/definitions/ProductCode.jsonld');
     }
+
+    /**
+     * Test related Schema keeps json-ld context.
+     */
+    public function testSubSchemaJsonLd(): void
+    {
+        $this->tester->run(['command' => 'api:json-schema:generate', 'resource' => 'ApiPlatform\Tests\Fixtures\TestBundle\Entity\RelatedDummy', '--type' => 'output', '--format' => 'jsonld']);
+        $result = $this->tester->getDisplay();
+        $json = json_decode($result, associative: true);
+
+        $this->assertArrayHasKey('@id', $json['definitions']['ThirdLevel.jsonld-friends']['properties']);
+    }
 }