Prevent that bad Ignore method annotations lead to incorrect results

astepin · astepin · commit db2a9de0623d · 2022-07-14T22:01:29.000+02:00
fix #45016
diff --git a/src/Symfony/Component/Serializer/Mapping/Loader/AnnotationLoader.php b/src/Symfony/Component/Serializer/Mapping/Loader/AnnotationLoader.php
@@ -134,6 +134,10 @@ public function loadClassMetadata(ClassMetadataInterface $classMetadata): bool
 
                     $attributeMetadata->setSerializedName($annotation->getSerializedName());
                 } elseif ($annotation instanceof Ignore) {
+                    if (!$accessorOrMutator) {
+                        throw new MappingException(sprintf('Ignore on "%s::%s()" cannot be added. Ignore can only be added on methods beginning with "get", "is", "has" or "set".', $className, $method->name));
+                    }
+
                     $attributeMetadata->setIgnore(true);
                 } elseif ($annotation instanceof Context) {
                     if (!$accessorOrMutator) {
diff --git a/src/Symfony/Component/Serializer/Tests/Fixtures/Annotations/Entity45016.php b/src/Symfony/Component/Serializer/Tests/Fixtures/Annotations/Entity45016.php
@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symfony\Component\Serializer\Tests\Fixtures\Annotations;
+
+use Symfony\Component\Serializer\Annotation\Ignore;
+
+class Entity45016
+{
+    public function __construct(private int $id = 1234) {}
+
+    public function getId(): int
+    {
+        return $this->id;
+    }
+
+    #[Ignore]
+    public function badIgnore(): bool
+    {
+        return true;
+    }
+}
diff --git a/src/Symfony/Component/Serializer/Tests/Mapping/Loader/AnnotationLoaderWithDoctrineAnnotationsTest.php b/src/Symfony/Component/Serializer/Tests/Mapping/Loader/AnnotationLoaderWithDoctrineAnnotationsTest.php
@@ -12,7 +12,10 @@
 namespace Symfony\Component\Serializer\Tests\Mapping\Loader;
 
 use Doctrine\Common\Annotations\AnnotationReader;
+use Symfony\Component\Serializer\Exception\MappingException;
+use Symfony\Component\Serializer\Mapping\ClassMetadata;
 use Symfony\Component\Serializer\Mapping\Loader\AnnotationLoader;
+use Symfony\Component\Serializer\Tests\Fixtures\Annotations\Entity45016;
 
 class AnnotationLoaderWithDoctrineAnnotationsTest extends AnnotationLoaderTest
 {
@@ -25,4 +28,15 @@ protected function getNamespace(): string
     {
         return 'Symfony\Component\Serializer\Tests\Fixtures\Annotations';
     }
+
+    public function testCanHandleUnrelatedIgnoredMethods()
+    {
+        $class = $this->getNamespace().'\Entity45016';
+
+        $this->expectException(MappingException::class);
+        $this->expectExceptionMessage(sprintf('Ignore on "%s::badIgnore()" cannot be added', $class));
+
+        $metadata = new ClassMetadata($class);
+        $this->loader->loadClassMetadata($metadata);
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,10 @@`
`12`	`12`	`namespace Symfony\Component\Serializer\Tests\Mapping\Loader;`
`13`	`13`
`14`	`14`	`use Doctrine\Common\Annotations\AnnotationReader;`
	`15`	`+use Symfony\Component\Serializer\Exception\MappingException;`
	`16`	`+use Symfony\Component\Serializer\Mapping\ClassMetadata;`
`15`	`17`	`use Symfony\Component\Serializer\Mapping\Loader\AnnotationLoader;`
	`18`	`+use Symfony\Component\Serializer\Tests\Fixtures\Annotations\Entity45016;`
`16`	`19`
`17`	`20`	`class AnnotationLoaderWithDoctrineAnnotationsTest extends AnnotationLoaderTest`
`18`	`21`	`{`
`@@ -25,4 +28,15 @@ protected function getNamespace(): string`
`25`	`28`	`{`
`26`	`29`	`return 'Symfony\Component\Serializer\Tests\Fixtures\Annotations';`
`27`	`30`	`}`
	`31`	`+`
	`32`	`+ public function testCanHandleUnrelatedIgnoredMethods()`
	`33`	`+ {`
	`34`	`+ $class = $this->getNamespace().'\Entity45016';`
	`35`	`+`
	`36`	`+ $this->expectException(MappingException::class);`
	`37`	`+ $this->expectExceptionMessage(sprintf('Ignore on "%s::badIgnore()" cannot be added', $class));`
	`38`	`+`
	`39`	`+ $metadata = new ClassMetadata($class);`
	`40`	`+ $this->loader->loadClassMetadata($metadata);`
	`41`	`+ }`
`28`	`42`	`}`