[Serializer] Return null and handle as InvalidArgumentException instead of ValueError if the data doesn't belong to a backed enum.

allison guilhem · allison guilhem · commit 6212e86e0bd3 · 2022-07-30T17:36:59.000+02:00
diff --git a/src/Symfony/Component/Serializer/Normalizer/BackedEnumNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/BackedEnumNormalizer.php
@@ -61,11 +61,12 @@ public function denormalize($data, $type, $format = null, array $context = [])
             throw NotNormalizableValueException::createForUnexpectedDataType('The data is neither an integer nor a string, you should pass an integer or a string that can be parsed as an enumeration case of type '.$type.'.', $data, [Type::BUILTIN_TYPE_INT, Type::BUILTIN_TYPE_STRING], $context['deserialization_path'] ?? null, true);
         }
 
-        try {
-            return $type::from($data);
-        } catch (\ValueError $e) {
-            throw NotNormalizableValueException::createForUnexpectedDataType($e->getMessage(), $data, [Type::BUILTIN_TYPE_INT, Type::BUILTIN_TYPE_STRING], $context['deserialization_path'] ?? null, true, $e->getCode(), $e);
+        $matched = $type::tryfrom($data);
+        if (!$matched) {
+            throw new InvalidArgumentException('The data must belong to a backed enumeration.');
         }
+
+        return $matched;
     }
 
     /**
diff --git a/src/Symfony/Component/Serializer/Tests/Normalizer/BackedEnumNormalizerTest.php b/src/Symfony/Component/Serializer/Tests/Normalizer/BackedEnumNormalizerTest.php
@@ -115,8 +115,7 @@ public function testDenormalizeObjectThrowsException()
      */
     public function testDenormalizeBadBackingValueThrowsException()
     {
-        $this->expectException(NotNormalizableValueException::class);
-        $this->expectExceptionMessage('"POST" is not a valid backing value for enum "'.StringBackedEnumDummy::class.'"');
+        $this->expectException(InvalidArgumentException::class);
         $this->normalizer->denormalize('POST', StringBackedEnumDummy::class);
     }
 

Original file line number	Diff line number	Diff line change
`@@ -61,11 +61,12 @@ public function denormalize($data, $type, $format = null, array $context = [])`
`61`	`61`	`throw NotNormalizableValueException::createForUnexpectedDataType('The data is neither an integer nor a string, you should pass an integer or a string that can be parsed as an enumeration case of type '.$type.'.', $data, [Type::BUILTIN_TYPE_INT, Type::BUILTIN_TYPE_STRING], $context['deserialization_path'] ?? null, true);`
`62`	`62`	`}`
`63`	`63`
`64`		`- try {`
`65`		`- return $type::from($data);`
`66`		`- } catch (\ValueError $e) {`
`67`		`- throw NotNormalizableValueException::createForUnexpectedDataType($e->getMessage(), $data, [Type::BUILTIN_TYPE_INT, Type::BUILTIN_TYPE_STRING], $context['deserialization_path'] ?? null, true, $e->getCode(), $e);`
	`64`	`+ $matched = $type::tryfrom($data);`
	`65`	`+ if (!$matched) {`
	`66`	`+ throw new InvalidArgumentException('The data must belong to a backed enumeration.');`
`68`	`67`	`}`
	`68`	`+`
	`69`	`+ return $matched;`
`69`	`70`	`}`
`70`	`71`
`71`	`72`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -115,8 +115,7 @@ public function testDenormalizeObjectThrowsException()`
`115`	`115`	`*/`
`116`	`116`	`public function testDenormalizeBadBackingValueThrowsException()`
`117`	`117`	`{`
`118`		`- $this->expectException(NotNormalizableValueException::class);`
`119`		`- $this->expectExceptionMessage('"POST" is not a valid backing value for enum "'.StringBackedEnumDummy::class.'"');`
	`118`	`+ $this->expectException(InvalidArgumentException::class);`
`120`	`119`	`$this->normalizer->denormalize('POST', StringBackedEnumDummy::class);`
`121`	`120`	`}`
`122`	`121`