bug #57541 [Serializer] [ObjectNormalizer] Use bool filter when FILTER_BOOL is set (Maximilian Zumbansen)

nicolas-grekas · nicolas-grekas · commit 0af0679b94b7 · 2024-06-28T09:42:43.000+02:00
This PR was squashed before being merged into the 7.1 branch. Discussion ---------- [Serializer] [ObjectNormalizer] Use bool filter when FILTER_BOOL is set | Q | A | ------------- | --- | Branch? | 7.1  | Bug fix? | yes | New feature? | no  | Deprecations? | no  | Issues | Fix #57540  | License | MIT With 7.1 it is possible to map query booleans to php bool parameters (https://symfony.com/blog/new-in-symfony-7-1-misc-improvements-part-3#mapping-boolean-query-string-parameters). But as we found out, this only works when the DTO is initialized via `construct`. Otherwise the `FILTER_BOOL` flag will be ignored and e.g. "false" will be deserialized as `true`. To fix this, I suggest to look for the `FILTER_BOOL` in the context and apply the filter, when the type is `bool` and the data is `string`. Commits ------- 6e657e8 [Serializer] [ObjectNormalizer] Use bool filter when FILTER_BOOL is set
diff --git a/src/Symfony/Component/Serializer/Normalizer/AbstractObjectNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/AbstractObjectNormalizer.php
@@ -566,6 +566,10 @@ private function validateAndDenormalizeLegacy(array $types, string $currentClass
                     return (float) $data;
                 }
 
+                if (LegacyType::BUILTIN_TYPE_BOOL === $builtinType && \is_string($data) && ($context[self::FILTER_BOOL] ?? false)) {
+                    return filter_var($data, \FILTER_VALIDATE_BOOL, \FILTER_NULL_ON_FAILURE);
+                }
+
                 if ((LegacyType::BUILTIN_TYPE_FALSE === $builtinType && false === $data) || (LegacyType::BUILTIN_TYPE_TRUE === $builtinType && true === $data)) {
                     return $data;
                 }
@@ -797,6 +801,10 @@ private function validateAndDenormalize(Type $type, string $currentClass, string
                     return (float) $data;
                 }
 
+                if (TypeIdentifier::BOOL === $typeIdentifier && \is_string($data) && ($context[self::FILTER_BOOL] ?? false)) {
+                    return filter_var($data, \FILTER_VALIDATE_BOOL, \FILTER_NULL_ON_FAILURE);
+                }
+
                 $dataMatchesExpectedType = match ($typeIdentifier) {
                     TypeIdentifier::ARRAY => \is_array($data),
                     TypeIdentifier::BOOL => \is_bool($data),
diff --git a/src/Symfony/Component/Serializer/Tests/Normalizer/AbstractObjectNormalizerTest.php b/src/Symfony/Component/Serializer/Tests/Normalizer/AbstractObjectNormalizerTest.php
@@ -1196,6 +1196,34 @@ public function provideBooleanTypesData()
             [['foo' => false], TruePropertyDummy::class],
         ];
     }
+
+    /**
+     * @dataProvider provideDenormalizeWithFilterBoolData
+     */
+    public function testDenormalizeBooleanTypeWithFilterBool(array $data, ?bool $expectedFoo)
+    {
+        $normalizer = new AbstractObjectNormalizerWithMetadataAndPropertyTypeExtractors();
+
+        $dummy = $normalizer->denormalize($data, BoolPropertyDummy::class, null, [AbstractNormalizer::FILTER_BOOL => true]);
+
+        $this->assertSame($expectedFoo, $dummy->foo);
+    }
+
+    public function provideDenormalizeWithFilterBoolData(): array
+    {
+        return [
+            [['foo' => 'true'], true],
+            [['foo' => '1'], true],
+            [['foo' => 'yes'], true],
+            [['foo' => 'false'], false],
+            [['foo' => '0'], false],
+            [['foo' => 'no'], false],
+            [['foo' => ''], false],
+            [['foo' => null], null],
+            [['foo' => 'null'], null],
+            [['foo' => 'something'], null],
+        ];
+    }
 }
 
 class AbstractObjectNormalizerDummy extends AbstractObjectNormalizer
@@ -1481,6 +1509,12 @@ class TruePropertyDummy
     public $foo;
 }
 
+class BoolPropertyDummy
+{
+    /** @var null|bool */
+    public $foo;
+}
+
 class SerializerCollectionDummy implements SerializerInterface, DenormalizerInterface
 {
     private array $normalizers;

Original file line number	Diff line number	Diff line change
`@@ -566,6 +566,10 @@ private function validateAndDenormalizeLegacy(array $types, string $currentClass`
`566`	`566`	`return (float) $data;`
`567`	`567`	`}`
`568`	`568`
	`569`	`+ if (LegacyType::BUILTIN_TYPE_BOOL === $builtinType && \is_string($data) && ($context[self::FILTER_BOOL] ?? false)) {`
	`570`	`+ return filter_var($data, \FILTER_VALIDATE_BOOL, \FILTER_NULL_ON_FAILURE);`
	`571`	`+ }`
	`572`	`+`
`569`	`573`	`if ((LegacyType::BUILTIN_TYPE_FALSE === $builtinType && false === $data) \|\| (LegacyType::BUILTIN_TYPE_TRUE === $builtinType && true === $data)) {`
`570`	`574`	`return $data;`
`571`	`575`	`}`
`@@ -797,6 +801,10 @@ private function validateAndDenormalize(Type $type, string $currentClass, string`
`797`	`801`	`return (float) $data;`
`798`	`802`	`}`
`799`	`803`
	`804`	`+ if (TypeIdentifier::BOOL === $typeIdentifier && \is_string($data) && ($context[self::FILTER_BOOL] ?? false)) {`
	`805`	`+ return filter_var($data, \FILTER_VALIDATE_BOOL, \FILTER_NULL_ON_FAILURE);`
	`806`	`+ }`
	`807`	`+`
`800`	`808`	`$dataMatchesExpectedType = match ($typeIdentifier) {`
`801`	`809`	`TypeIdentifier::ARRAY => \is_array($data),`
`802`	`810`	`TypeIdentifier::BOOL => \is_bool($data),`