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

lyrixx · lyrixx · commit 54a3436258f9 · 2021-08-18T10:42:58.000+02:00
diff --git a/src/Symfony/Component/Serializer/CHANGELOG.md b/src/Symfony/Component/Serializer/CHANGELOG.md
@@ -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
 ---
diff --git a/src/Symfony/Component/Serializer/Serializer.php b/src/Symfony/Component/Serializer/Serializer.php
@@ -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', 'The method "%s()" will return an instance of "%s" as of Symfony 6.0 when the object is iteratable, countable and empty.', __METHOD__, \ArrayObject::class);
+                        }
+
                         return $data;
                     case ($context[self::EMPTY_ARRAY_AS_OBJECT] ?? false) && \is_array($data):
                         return new \ArrayObject();
diff --git a/src/Symfony/Component/Serializer/Tests/SerializerTest.php b/src/Symfony/Component/Serializer/Tests/SerializerTest.php
@@ -578,7 +578,10 @@ public function testNormalizeWithCollection(Serializer $serializer, array $data)
         $this->assertSame($expected, $serializer->serialize($data, 'json'));
     }
 
-    /** @dataProvider provideObjectOrCollectionTests */
+    /**
+     * @dataProvider provideObjectOrCollectionTests
+     * @group legacy
+     */
     public function testNormalizePreserveEmptyArrayObject(Serializer $serializer, array $data)
     {
         $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":[]}}';
@@ -596,7 +599,10 @@ public function testNormalizeEmptyArrayAsObject(Serializer $serializer, array $d
         ]));
     }
 
-    /** @dataProvider provideObjectOrCollectionTests */
+    /**
+     * @dataProvider provideObjectOrCollectionTests
+     * @group legacy
+     */
     public function testNormalizeEmptyArrayAsObjectAndPreserveEmptyArrayObject(Serializer $serializer, array $data)
     {
         $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":{}}}';

Original file line number	Diff line number	Diff line change
`@@ -578,7 +578,10 @@ public function testNormalizeWithCollection(Serializer $serializer, array $data)`
`578`	`578`	`$this->assertSame($expected, $serializer->serialize($data, 'json'));`
`579`	`579`	`}`
`580`	`580`
`581`		`- /** @dataProvider provideObjectOrCollectionTests */`
	`581`	`+ /**`
	`582`	`+ * @dataProvider provideObjectOrCollectionTests`
	`583`	`+ * @group legacy`
	`584`	`+ */`
`582`	`585`	`public function testNormalizePreserveEmptyArrayObject(Serializer $serializer, array $data)`
`583`	`586`	`{`
`584`	`587`	`$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":[]}}';`
`@@ -596,7 +599,10 @@ public function testNormalizeEmptyArrayAsObject(Serializer $serializer, array $d`
`596`	`599`	`]));`
`597`	`600`	`}`
`598`	`601`
`599`		`- /** @dataProvider provideObjectOrCollectionTests */`
	`602`	`+ /**`
	`603`	`+ * @dataProvider provideObjectOrCollectionTests`
	`604`	`+ * @group legacy`
	`605`	`+ */`
`600`	`606`	`public function testNormalizeEmptyArrayAsObjectAndPreserveEmptyArrayObject(Serializer $serializer, array $data)`
`601`	`607`	`{`
`602`	`608`	`$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":{}}}';`