fixup! feat: allow to output null links for haljson also test embedded properties

Author: BacLuc

tests/Fixtures/TestBundle/ApiResource/Issue4372/RelatedEntity.php

@@ -17,6 +17,7 @@
 use ApiPlatform\Metadata\ApiResource;
 use ApiPlatform\Metadata\Get;
 use ApiPlatform\Metadata\GetCollection;
+use Symfony\Component\Serializer\Annotation\Groups;
 
 #[ApiResource(
     operations: [
@@ -27,5 +28,6 @@
 class RelatedEntity
 {
     #[ApiProperty(identifier: true)]
+    #[Groups(['read'])]
     public ?int $id = null;
 }

tests/Fixtures/TestBundle/ApiResource/Issue4372/ToOneRelationPropertyMayBeNull.php

@@ -21,6 +21,7 @@
 use ApiPlatform\Serializer\AbstractItemNormalizer;
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\Common\Collections\Collection;
+use Symfony\Component\Serializer\Annotation\Groups;
 
 #[ApiResource(
     operations: [
@@ -31,11 +32,15 @@
             uriTemplate: self::ITEM_ROUTE.'{._format}',
             normalizationContext: [
                 AbstractItemNormalizer::SKIP_NULL_TO_ONE_RELATIONS => false,
+                'groups' => ['default', 'read'],
             ],
             provider: [self::class, 'provide']
         ),
         new Get(
             uriTemplate: self::ITEM_SKIP_NULL_TO_ONE_RELATION_ROUTE.'{._format}',
+            normalizationContext: [
+                'groups' => ['default', 'read'],
+            ],
             provider: [self::class, 'provide']
         ),
     ],
@@ -48,17 +53,26 @@ class ToOneRelationPropertyMayBeNull
     public const ITEM_SKIP_NULL_TO_ONE_RELATION_ROUTE = self::SKIP_NULL_TO_ONE_RELATION_ROUTE.'/{id}';
     public const ENTITY_ID = 1;
 
-    /** @noinspection PhpPropertyOnlyWrittenInspection */
     #[ApiProperty(identifier: true)]
-    private ?int $id = null; // @phpstan-ignore-line
+    #[Groups(['read'])]
+    public ?int $id = null;
 
     #[ApiProperty]
     public ?RelatedEntity $relatedEntity = null;
 
+    #[ApiProperty(readableLink: true)]
+    #[Groups(['read'])]
+    public ?RelatedEntity $relatedEmbeddedEntity = null;
+
     #[ApiProperty]
     public ?RelatedEntity $relatedEntity2 = null;
 
+    #[ApiProperty(readableLink: true)]
+    #[Groups(['read'])]
+    public ?RelatedEntity $relatedEmbeddedEntity2 = null;
+
     #[ApiProperty]
+    #[Groups(['read'])]
     public Collection $collection;
 
     public function __construct()
@@ -76,6 +90,7 @@ public static function provide(Operation $operation, array $uriVariables = [], a
         $toOneRelationPropertyMayBeNull = new self();
         $toOneRelationPropertyMayBeNull->id = self::ENTITY_ID;
         $toOneRelationPropertyMayBeNull->relatedEntity2 = $relatedEntity1;
+        $toOneRelationPropertyMayBeNull->relatedEmbeddedEntity2 = $relatedEntity1;
         $toOneRelationPropertyMayBeNull->collection = new ArrayCollection([$relatedEntity1, $relatedEntity2]);
 
         return $toOneRelationPropertyMayBeNull;

tests/Functional/NotSkipNullToOneRelationTest.php

@@ -68,12 +68,23 @@ public function testNullRelationsAreNotSkippedWhenConfigured(): void
 
         $this->assertJsonEquals(
             [
+                '_embedded' => [
+                    'relatedEmbeddedEntity' => null,
+                    'relatedEmbeddedEntity2' => [
+                        '_links' => [
+                            'self' => [
+                                'href' => '/related_entities/1',
+                            ],
+                        ],
+                        'id' => 1,
+                    ],
+                ],
                 '_links' => [
                     'self' => [
-                        'href' => $itemIri,
+                        'href' => '/my-route/1',
                     ],
-                    'relatedEntity' => null,
-                    'relatedEntity2' => [
+                    'relatedEmbeddedEntity' => null,
+                    'relatedEmbeddedEntity2' => [
                         'href' => '/related_entities/1',
                     ],
                 ],
@@ -95,6 +106,7 @@ public function testNullRelationsAreNotSkippedWhenConfigured(): void
                         'id' => 2,
                     ],
                 ],
+                'id' => 1,
             ]
         );
     }
@@ -130,11 +142,21 @@ public function testNullRelationsAreSkippedByDefault(): void
 
         $this->assertJsonEquals(
             [
+                '_embedded' => [
+                    'relatedEmbeddedEntity2' => [
+                        '_links' => [
+                            'self' => [
+                                'href' => '/related_entities/1',
+                            ],
+                        ],
+                        'id' => 1,
+                    ],
+                ],
                 '_links' => [
                     'self' => [
-                        'href' => $itemIri,
+                        'href' => '/skip-null-relation-route/1',
                     ],
-                    'relatedEntity2' => [
+                    'relatedEmbeddedEntity2' => [
                         'href' => '/related_entities/1',
                     ],
                 ],
@@ -156,6 +178,7 @@ public function testNullRelationsAreSkippedByDefault(): void
                         'id' => 2,
                     ],
                 ],
+                'id' => 1,
             ]
         );
     }