Skip to content

Commit 08450c2

Browse files
alanpoulainalanpoulain
authored
fix(serializer): support empty array as object (api-platform#4999)
Fixes an issue with the use of `EMPTY_ARRAY_AS_OBJECT` and `PRESERVE_EMPTY_OBJECTS` in the serialization context. Since the CollectionNormalizer was taking over the serialization of all iterables, the Symfony serializer was not called when normalizing a "raw" collection. Adding a better supports method fixes the issue. The supports method is not cacheable anymore since it relies on the context.
1 parent f40d57a commit 08450c2

File tree

9 files changed

+136
-205
lines changed

9 files changed

+136
-205
lines changed

‎features/serializer/empty_array_as_object.feature‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
Feature: Serialize empty array as object
2+
In order to have a coherent JSON representation
3+
As a developer
4+
I should be able to serialize some empty array properties as objects
5+
6+
@createSchema
7+
Scenario: Get a resource with empty array properties as objects
8+
When I add "Content-Type" header equal to "application/ld+json"
9+
And I send a "GET" request to "/empty_array_as_objects/5"
10+
Then the response status code should be 200
11+
And the response should be in JSON
12+
And the header "Content-Type" should be equal to "application/ld+json; charset=utf-8"
13+
And the JSON should be equal to:
14+
"""
15+
{
16+
"@context": "/contexts/EmptyArrayAsObject",
17+
"@id": "/empty_array_as_objects/6",
18+
"@type": "EmptyArrayAsObject",
19+
"id": 6,
20+
"emptyArray": [],
21+
"emptyArrayAsObject": {},
22+
"arrayObjectAsArray": [],
23+
"arrayObject": {},
24+
"stringArray": [
25+
"foo",
26+
"bar"
27+
],
28+
"objectArray": {
29+
"foo": 67,
30+
"bar": "baz"
31+
}
32+
}
33+
"""

‎src/Hydra/Serializer/CollectionNormalizer.php‎

Lines changed: 2 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ public function __construct(private readonly ContextBuilderInterface $contextBui
5656
*/
5757
public function supportsNormalization(mixed $data, string $format = null, array $context = []): bool
5858
{
59-
return self::FORMAT === $format && is_iterable($data);
59+
return self::FORMAT === $format && is_iterable($data) && isset($context['resource_class']) && !isset($context['api_sub_level']);
6060
}
6161

6262
/**
@@ -66,10 +66,6 @@ public function supportsNormalization(mixed $data, string $format = null, array
6666
*/
6767
public function normalize(mixed $object, string $format = null, array $context = []): array
6868
{
69-
if (!isset($context['resource_class']) || isset($context['api_sub_level'])) {
70-
return $this->normalizeRawCollection($object, $format, $context);
71-
}
72-
7369
$resourceClass = $this->resourceClassResolver->getResourceClass($object, $context['resource_class']);
7470
$context = $this->initContext($resourceClass, $context);
7571
$data = $this->addJsonLdContext($this->contextBuilder, $resourceClass, $context);
@@ -106,19 +102,6 @@ public function normalize(mixed $object, string $format = null, array $context =
106102

107103
public function hasCacheableSupportsMethod(): bool
108104
{
109-
return true;
110-
}
111-
112-
/**
113-
* Normalizes a raw collection (not API resources).
114-
*/
115-
private function normalizeRawCollection(iterable $object, ?string $format, array $context): array
116-
{
117-
$data = [];
118-
foreach ($object as $index => $obj) {
119-
$data[$index] = $this->normalizer->normalize($obj, $format, $context);
120-
}
121-
122-
return $data;
105+
return false;
123106
}
124107
}

‎src/Serializer/AbstractCollectionNormalizer.php‎

Lines changed: 2 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -50,12 +50,12 @@ public function __construct(protected ResourceClassResolverInterface $resourceCl
5050
*/
5151
public function supportsNormalization(mixed $data, string $format = null, array $context = []): bool
5252
{
53-
return static::FORMAT === $format && is_iterable($data);
53+
return static::FORMAT === $format && is_iterable($data) && isset($context['resource_class']) && !isset($context['api_sub_level']);
5454
}
5555

5656
public function hasCacheableSupportsMethod(): bool
5757
{
58-
return true;
58+
return false;
5959
}
6060

6161
/**
@@ -65,10 +65,6 @@ public function hasCacheableSupportsMethod(): bool
6565
*/
6666
public function normalize(mixed $object, string $format = null, array $context = []): array|string|int|float|bool|\ArrayObject|null
6767
{
68-
if (!isset($context['resource_class']) || isset($context['api_sub_level'])) {
69-
return $this->normalizeRawCollection($object, $format, $context);
70-
}
71-
7268
$resourceClass = $this->resourceClassResolver->getResourceClass($object, $context['resource_class']);
7369
$context = $this->initContext($resourceClass, $context);
7470
$data = [];
@@ -86,19 +82,6 @@ public function normalize(mixed $object, string $format = null, array $context =
8682
return array_merge_recursive($data, $paginationData, $itemsData);
8783
}
8884

89-
/**
90-
* Normalizes a raw collection (not API resources).
91-
*/
92-
protected function normalizeRawCollection(iterable $object, string $format = null, array $context = []): array
93-
{
94-
$data = [];
95-
foreach ($object as $index => $obj) {
96-
$data[$index] = $this->normalizer->normalize($obj, $format, $context);
97-
}
98-
99-
return $data;
100-
}
101-
10285
/**
10386
* Gets the pagination configuration.
10487
*/

‎tests/Fixtures/TestBundle/Model/EmptyArrayAsObject.php‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the API Platform project.
5+
*
6+
* (c) Kévin Dunglas <[email protected]>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
declare(strict_types=1);
13+
14+
namespace ApiPlatform\Tests\Fixtures\TestBundle\Model;
15+
16+
use ApiPlatform\Metadata\ApiResource;
17+
use ApiPlatform\Metadata\Get;
18+
use ApiPlatform\Tests\Fixtures\TestBundle\State\EmptyArrayAsObjectProvider;
19+
use Symfony\Component\Serializer\Annotation\Context;
20+
use Symfony\Component\Serializer\Normalizer\AbstractObjectNormalizer;
21+
use Symfony\Component\Serializer\Serializer;
22+
23+
#[ApiResource(operations: [new Get()], provider: EmptyArrayAsObjectProvider::class)]
24+
class EmptyArrayAsObject
25+
{
26+
public int $id = 6;
27+
28+
public array $emptyArray = [];
29+
30+
#[Context([Serializer::EMPTY_ARRAY_AS_OBJECT => true, AbstractObjectNormalizer::PRESERVE_EMPTY_OBJECTS => true])]
31+
public array $emptyArrayAsObject = [];
32+
33+
public \ArrayObject $arrayObjectAsArray;
34+
35+
#[Context([AbstractObjectNormalizer::PRESERVE_EMPTY_OBJECTS => true])]
36+
public \ArrayObject $arrayObject;
37+
38+
public array $stringArray = ['foo', 'bar'];
39+
40+
public array $objectArray = ['foo' => 67, 'bar' => 'baz'];
41+
42+
public function __construct()
43+
{
44+
$this->arrayObjectAsArray = new \ArrayObject();
45+
$this->arrayObject = new \ArrayObject();
46+
}
47+
}

‎tests/Fixtures/TestBundle/State/EmptyArrayAsObjectProvider.php‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the API Platform project.
5+
*
6+
* (c) Kévin Dunglas <[email protected]>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
declare(strict_types=1);
13+
14+
namespace ApiPlatform\Tests\Fixtures\TestBundle\State;
15+
16+
use ApiPlatform\Metadata\Operation;
17+
use ApiPlatform\State\ProviderInterface;
18+
use ApiPlatform\Tests\Fixtures\TestBundle\Model\EmptyArrayAsObject;
19+
20+
final class EmptyArrayAsObjectProvider implements ProviderInterface
21+
{
22+
public function provide(Operation $operation, array $uriVariables = [], array $context = []): EmptyArrayAsObject
23+
{
24+
return new EmptyArrayAsObject();
25+
}
26+
}

‎tests/Fixtures/app/config/config_common.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,11 @@ services:
137137
tags:
138138
- { name: 'api_platform.state_provider' }
139139

140+
ApiPlatform\Tests\Fixtures\TestBundle\State\EmptyArrayAsObjectProvider:
141+
class: 'ApiPlatform\Tests\Fixtures\TestBundle\State\EmptyArrayAsObjectProvider'
142+
tags:
143+
- { name: 'api_platform.state_provider' }
144+
140145
ApiPlatform\Tests\Fixtures\TestBundle\State\CarProcessor:
141146
class: 'ApiPlatform\Tests\Fixtures\TestBundle\State\CarProcessor'
142147
tags:

‎tests/Hal/Serializer/CollectionNormalizerTest.php‎

Lines changed: 7 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -39,26 +39,13 @@ public function testSupportsNormalize(): void
3939
$resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataCollectionFactoryInterface::class);
4040
$normalizer = new CollectionNormalizer($resourceClassResolverProphecy->reveal(), 'page', $resourceMetadataFactoryProphecy->reveal());
4141

42-
$this->assertTrue($normalizer->supportsNormalization([], CollectionNormalizer::FORMAT));
43-
$this->assertTrue($normalizer->supportsNormalization(new \ArrayObject(), CollectionNormalizer::FORMAT));
44-
$this->assertFalse($normalizer->supportsNormalization([], 'xml'));
45-
$this->assertFalse($normalizer->supportsNormalization(new \ArrayObject(), 'xml'));
46-
$this->assertTrue($normalizer->hasCacheableSupportsMethod());
47-
}
48-
49-
public function testNormalizeApiSubLevel(): void
50-
{
51-
$resourceClassResolverProphecy = $this->prophesize(ResourceClassResolverInterface::class);
52-
$resourceClassResolverProphecy->getResourceClass()->shouldNotBeCalled();
53-
$resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataCollectionFactoryInterface::class);
54-
55-
$itemNormalizer = $this->prophesize(NormalizerInterface::class);
56-
$itemNormalizer->normalize('bar', null, ['api_sub_level' => true])->willReturn(22);
57-
58-
$normalizer = new CollectionNormalizer($resourceClassResolverProphecy->reveal(), 'page', $resourceMetadataFactoryProphecy->reveal());
59-
$normalizer->setNormalizer($itemNormalizer->reveal());
60-
61-
$this->assertEquals(['foo' => 22], $normalizer->normalize(['foo' => 'bar'], null, ['api_sub_level' => true]));
42+
$this->assertTrue($normalizer->supportsNormalization([], CollectionNormalizer::FORMAT, ['resource_class' => 'Foo']));
43+
$this->assertFalse($normalizer->supportsNormalization([], CollectionNormalizer::FORMAT, ['resource_class' => 'Foo', 'api_sub_level' => true]));
44+
$this->assertFalse($normalizer->supportsNormalization([], CollectionNormalizer::FORMAT, []));
45+
$this->assertTrue($normalizer->supportsNormalization(new \ArrayObject(), CollectionNormalizer::FORMAT, ['resource_class' => 'Foo']));
46+
$this->assertFalse($normalizer->supportsNormalization([], 'xml', ['resource_class' => 'Foo']));
47+
$this->assertFalse($normalizer->supportsNormalization(new \ArrayObject(), 'xml', ['resource_class' => 'Foo']));
48+
$this->assertFalse($normalizer->hasCacheableSupportsMethod());
6249
}
6350

6451
public function testNormalizePaginator(): void

0 commit comments

Comments
 (0)