Skip to content

[Serializer] Deprecate support for returning empty, iterable, countable, raw object when normalizing #42619

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 23, 2021
Merged

[Serializer] Deprecate support for returning empty, iterable, countable, raw object when normalizing #42619

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/Symfony/Component/Serializer/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ CHANGELOG

* Add support of PHP backed enumerations
* Add support for serializing empty array as object
* Deprecate support for returning empty, iterable, countable, raw object when normalizing

5.3
---
Expand Down
4 changes: 4 additions & 0 deletions src/Symfony/Component/Serializer/Serializer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,10 @@ public function normalize($data, string $format = null, array $context = [])
if (is_countable($data) && 0 === \count($data)) {
switch (true) {
case ($context[AbstractObjectNormalizer::PRESERVE_EMPTY_OBJECTS] ?? false) && \is_object($data):
if (!$data instanceof \ArrayObject) {
trigger_deprecation('symfony/serializer', '5.4', 'Returning empty object of class "%s" from "%s()" is deprecated. This class should extend "ArrayObject".', get_debug_type($data), __METHOD__);
}

return $data;
case ($context[self::EMPTY_ARRAY_AS_OBJECT] ?? false) && \is_array($data):
return new \ArrayObject();
Expand Down
91 changes: 90 additions & 1 deletion src/Symfony/Component/Serializer/Tests/SerializerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -606,6 +606,61 @@ public function testNormalizeEmptyArrayAsObjectAndPreserveEmptyArrayObject(Seria
]));
}

/**
* @dataProvider provideObjectOrCollectionTests
* @group legacy
*/
public function testNormalizeWithCollectionLegacy(Serializer $serializer, array $data)
{
$data['g1'] = new BazLegacy([]);
$data['g2'] = new BazLegacy(['greg']);
$expected = '{"a1":[],"a2":{"k":"v"},"b1":[],"b2":{"k":"v"},"c1":{"nested":[]},"c2":{"nested":{"k":"v"}},"d1":{"nested":[]},"d2":{"nested":{"k":"v"}},"e1":{"map":[]},"e2":{"map":{"k":"v"}},"f1":{"map":[]},"f2":{"map":{"k":"v"}},"g1":{"list":[],"settings":[]},"g2":{"list":["greg"],"settings":[]}}';
$this->assertSame($expected, $serializer->serialize($data, 'json'));
}

/**
* @dataProvider provideObjectOrCollectionTests
* @group legacy
*/
public function testNormalizePreserveEmptyArrayObjectLegacy(Serializer $serializer, array $data)
{
$data['g1'] = new BazLegacy([]);
$data['g2'] = new BazLegacy(['greg']);
$expected = '{"a1":{},"a2":{"k":"v"},"b1":[],"b2":{"k":"v"},"c1":{"nested":{}},"c2":{"nested":{"k":"v"}},"d1":{"nested":[]},"d2":{"nested":{"k":"v"}},"e1":{"map":[]},"e2":{"map":{"k":"v"}},"f1":{"map":{}},"f2":{"map":{"k":"v"}},"g1":{"list":{"list":[]},"settings":[]},"g2":{"list":["greg"],"settings":[]}}';
$this->assertSame($expected, $serializer->serialize($data, 'json', [
AbstractObjectNormalizer::PRESERVE_EMPTY_OBJECTS => true,
]));
}

/**
* @dataProvider provideObjectOrCollectionTests
* @group legacy
*/
public function testNormalizeEmptyArrayAsObjectLegacy(Serializer $serializer, array $data)
{
$data['g1'] = new BazLegacy([]);
$data['g2'] = new BazLegacy(['greg']);
$expected = '{"a1":[],"a2":{"k":"v"},"b1":{},"b2":{"k":"v"},"c1":{"nested":[]},"c2":{"nested":{"k":"v"}},"d1":{"nested":{}},"d2":{"nested":{"k":"v"}},"e1":{"map":{}},"e2":{"map":{"k":"v"}},"f1":{"map":[]},"f2":{"map":{"k":"v"}},"g1":{"list":[],"settings":{}},"g2":{"list":["greg"],"settings":{}}}';
$this->assertSame($expected, $serializer->serialize($data, 'json', [
Serializer::EMPTY_ARRAY_AS_OBJECT => true,
]));
}

/**
* @dataProvider provideObjectOrCollectionTests
* @group legacy
*/
public function testNormalizeEmptyArrayAsObjectAndPreserveEmptyArrayObjectLegacy(Serializer $serializer, array $data)
{
$data['g1'] = new BazLegacy([]);
$data['g2'] = new BazLegacy(['greg']);
$expected = '{"a1":{},"a2":{"k":"v"},"b1":{},"b2":{"k":"v"},"c1":{"nested":{}},"c2":{"nested":{"k":"v"}},"d1":{"nested":{}},"d2":{"nested":{"k":"v"}},"e1":{"map":{}},"e2":{"map":{"k":"v"}},"f1":{"map":{}},"f2":{"map":{"k":"v"}},"g1":{"list":{"list":[]},"settings":{}},"g2":{"list":["greg"],"settings":{}}}';
$this->assertSame($expected, $serializer->serialize($data, 'json', [
Serializer::EMPTY_ARRAY_AS_OBJECT => true,
AbstractObjectNormalizer::PRESERVE_EMPTY_OBJECTS => true,
]));
}

public function testNormalizeScalar()
{
$serializer = new Serializer([], ['json' => new JsonEncoder()]);
Expand Down Expand Up @@ -791,7 +846,41 @@ public function __construct(array $list)
}
}

class DummyList implements \Countable, \IteratorAggregate
class DummyList extends \ArrayObject
{
public $list;

public function __construct(array $list)
{
$this->list = $list;

$this->setFlags(\ArrayObject::STD_PROP_LIST);
}

public function count(): int
{
return \count($this->list);
}

public function getIterator(): \Traversable
{
return new \ArrayIterator($this->list);
}
}

class BazLegacy
{
public $list;

public $settings = [];

public function __construct(array $list)
{
$this->list = new DummyListLegacy($list);
}
}

class DummyListLegacy implements \Countable, \IteratorAggregate
{
public $list;

Expand Down