[Serializer] Add flag to require all properties to be listed in the input

Author: Christian Kolb

CHANGELOG.md

@@ -4,6 +4,7 @@ CHANGELOG
 6.3
 ---
 
+ * Add `AbstractNormalizer::REQUIRE_ALL_PROPERTIES` context flag to require all properties to be listed in the input instead of falling back to null for nullable ones
  * Add `XmlEncoder::SAVE_OPTIONS` context option
  * Add `BackedEnumNormalizer::ALLOW_INVALID_VALUES` context option
  * Add `UnsupportedFormatException` which is thrown when there is no decoder for a given format

Context/Normalizer/AbstractNormalizerContextBuilder.php

@@ -164,4 +164,13 @@ public function withIgnoredAttributes(?array $ignoredAttributes): static
     {
         return $this->with(AbstractNormalizer::IGNORED_ATTRIBUTES, $ignoredAttributes);
     }
+
+    /**
+     * Configures requiring all properties to be listed in the input instead
+     * of falling back to null for nullable ones.
+     */
+    public function withRequireAllProperties(?bool $requireAllProperties = true): static
+    {
+        return $this->with(AbstractNormalizer::REQUIRE_ALL_PROPERTIES, $requireAllProperties);
+    }
 }

Normalizer/AbstractNormalizer.php

@@ -112,6 +112,12 @@ abstract class AbstractNormalizer implements NormalizerInterface, DenormalizerIn
      */
     public const IGNORED_ATTRIBUTES = 'ignored_attributes';
 
+    /**
+     * Require all properties to be listed in the input instead of falling
+     * back to null for nullable ones.
+     */
+    public const REQUIRE_ALL_PROPERTIES = 'require_all_properties';
+
     /**
      * @internal
      */
@@ -383,7 +389,7 @@ protected function instantiateObject(array &$data, string $class, array &$contex
                     $params[] = $this->defaultContext[self::DEFAULT_CONSTRUCTOR_ARGUMENTS][$class][$key];
                 } elseif ($constructorParameter->isDefaultValueAvailable()) {
                     $params[] = $constructorParameter->getDefaultValue();
-                } elseif ($constructorParameter->hasType() && $constructorParameter->getType()->allowsNull()) {
+                } elseif (!($context[self::REQUIRE_ALL_PROPERTIES] ?? $this->defaultContext[self::REQUIRE_ALL_PROPERTIES] ?? false) && $constructorParameter->hasType() && $constructorParameter->getType()->allowsNull()) {
                     $params[] = null;
                 } else {
                     if (!isset($context['not_normalizable_value_exceptions'])) {

Tests/Context/Normalizer/AbstractNormalizerContextBuilderTest.php

@@ -45,6 +45,7 @@ public function testWithers(array $values)
             ->withCallbacks($values[AbstractNormalizer::CALLBACKS])
             ->withCircularReferenceHandler($values[AbstractNormalizer::CIRCULAR_REFERENCE_HANDLER])
             ->withIgnoredAttributes($values[AbstractNormalizer::IGNORED_ATTRIBUTES])
+            ->withRequireAllProperties($values[AbstractNormalizer::REQUIRE_ALL_PROPERTIES])
             ->toArray();
 
         $this->assertEquals($values, $context);
@@ -65,6 +66,7 @@ public static function withersDataProvider(): iterable
             AbstractNormalizer::CALLBACKS => [static function (): void {}],
             AbstractNormalizer::CIRCULAR_REFERENCE_HANDLER => static function (): void {},
             AbstractNormalizer::IGNORED_ATTRIBUTES => ['attribute3'],
+            AbstractNormalizer::REQUIRE_ALL_PROPERTIES => true,
         ]];
 
         yield 'With null values' => [[
@@ -77,6 +79,7 @@ public static function withersDataProvider(): iterable
             AbstractNormalizer::CALLBACKS => null,
             AbstractNormalizer::CIRCULAR_REFERENCE_HANDLER => null,
             AbstractNormalizer::IGNORED_ATTRIBUTES => null,
+            AbstractNormalizer::REQUIRE_ALL_PROPERTIES => null,
         ]];
     }
 

Tests/Normalizer/AbstractNormalizerTest.php

@@ -15,6 +15,7 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\PropertyInfo\Extractor\PhpDocExtractor;
 use Symfony\Component\Serializer\Encoder\JsonEncoder;
+use Symfony\Component\Serializer\Exception\MissingConstructorArgumentsException;
 use Symfony\Component\Serializer\Mapping\AttributeMetadata;
 use Symfony\Component\Serializer\Mapping\ClassMetadata;
 use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactory;
@@ -166,6 +167,15 @@ public function testObjectWithNullableNonOptionalConstructorArgumentWithoutInput
         $this->assertNull($dummy->getFoo());
     }
 
+    public function testObjectWithNullableNonOptionalConstructorArgumentWithoutInputAndRequireAllProperties()
+    {
+        $normalizer = new ObjectNormalizer();
+
+        $this->expectException(MissingConstructorArgumentsException::class);
+
+        $normalizer->denormalize([], NullableConstructorArgumentDummy::class, null, [AbstractNormalizer::REQUIRE_ALL_PROPERTIES => true]);
+    }
+
     /**
      * @dataProvider getNormalizer
      */