[Validator] Only trigger deprecation when Validator annotations are used

HypeMC · HypeMC · commit 78272a37a7c7 · 2023-12-02T16:09:43.000+01:00
diff --git a/src/Symfony/Component/Validator/Mapping/Loader/AnnotationLoader.php b/src/Symfony/Component/Validator/Mapping/Loader/AnnotationLoader.php
@@ -118,13 +118,13 @@ private function getAnnotations(\ReflectionMethod|\ReflectionClass|\ReflectionPr
         $annotations = [];
 
         if ($reflection instanceof \ReflectionClass && $annotations = $this->reader->getClassAnnotations($reflection)) {
-            trigger_deprecation('symfony/validator', '6.4', 'Class "%s" uses Doctrine Annotations to configure validation constraints, which is deprecated. Use PHP attributes instead.', $reflection->getName());
+            $this->triggerDeprecationIfAnnotationIsUsed($annotations, sprintf('Class "%s"', $reflection->getName()));
         }
         if ($reflection instanceof \ReflectionMethod && $annotations = $this->reader->getMethodAnnotations($reflection)) {
-            trigger_deprecation('symfony/validator', '6.4', 'Method "%s::%s()" uses Doctrine Annotations to configure validation constraints, which is deprecated. Use PHP attributes instead.', $reflection->getDeclaringClass()->getName(), $reflection->getName());
+            $this->triggerDeprecationIfAnnotationIsUsed($annotations, sprintf('Method "%s::%s()"', $reflection->getDeclaringClass()->getName(), $reflection->getName()));
         }
         if ($reflection instanceof \ReflectionProperty && $annotations = $this->reader->getPropertyAnnotations($reflection)) {
-            trigger_deprecation('symfony/validator', '6.4', 'Property "%s::$%s" uses Doctrine Annotations to configure validation constraints, which is deprecated. Use PHP attributes instead.', $reflection->getDeclaringClass()->getName(), $reflection->getName());
+            $this->triggerDeprecationIfAnnotationIsUsed($annotations, sprintf('Property "%s::$%s"', $reflection->getDeclaringClass()->getName(), $reflection->getName()));
         }
 
         foreach ($dedup as $annotation) {
@@ -142,4 +142,18 @@ private function getAnnotations(\ReflectionMethod|\ReflectionClass|\ReflectionPr
             }
         }
     }
+
+    private function triggerDeprecationIfAnnotationIsUsed(array $annotations, string $messagePrefix): void
+    {
+        foreach ($annotations as $annotation) {
+            if (
+                $annotation instanceof GroupSequence
+                || $annotation instanceof GroupSequenceProvider
+                || $annotation instanceof Constraint
+            ) {
+                trigger_deprecation('symfony/validator', '6.4', sprintf('%s uses Doctrine Annotations to configure validation constraints, which is deprecated. Use PHP attributes instead.', $messagePrefix));
+                break;
+            }
+        }
+    }
 }
diff --git a/src/Symfony/Component/Validator/Tests/Mapping/Loader/AnnotationLoaderWithHybridAnnotationsTest.php b/src/Symfony/Component/Validator/Tests/Mapping/Loader/AnnotationLoaderWithHybridAnnotationsTest.php
@@ -13,6 +13,8 @@
 
 use Doctrine\Common\Annotations\AnnotationReader;
 use Symfony\Bridge\PhpUnit\ExpectDeprecationTrait;
+use Symfony\Component\Validator\Constraints\NotBlank;
+use Symfony\Component\Validator\Mapping\ClassMetadata;
 use Symfony\Component\Validator\Mapping\Loader\AnnotationLoader;
 
 /**
@@ -46,6 +48,14 @@ public function testLoadClassMetadataAndMerge()
         parent::testLoadClassMetadataAndMerge();
     }
 
+    public function testLoadClassMetadataWithOtherAnnotations()
+    {
+        $loader = $this->createAnnotationLoader();
+        $metadata = new ClassMetadata(EntityWithOtherAnnotations::class);
+
+        $this->assertTrue($loader->loadClassMetadata($metadata));
+    }
+
     protected function createAnnotationLoader(): AnnotationLoader
     {
         return new AnnotationLoader(new AnnotationReader());
@@ -56,3 +66,20 @@ protected function getFixtureNamespace(): string
         return 'Symfony\Component\Validator\Tests\Fixtures\Attribute';
     }
 }
+
+/**
+ * @Annotation
+ * @Target({"PROPERTY"})
+ */
+class SomeAnnotation
+{
+}
+
+class EntityWithOtherAnnotations
+{
+    /**
+     * @SomeAnnotation
+     */
+    #[NotBlank]
+    public ?string $name = null;
+}

Original file line number	Diff line number	Diff line change
`@@ -118,13 +118,13 @@ private function getAnnotations(\ReflectionMethod\|\ReflectionClass\|\ReflectionPr`
`118`	`118`	`$annotations = [];`
`119`	`119`
`120`	`120`	`if ($reflection instanceof \ReflectionClass && $annotations = $this->reader->getClassAnnotations($reflection)) {`
`121`		`- trigger_deprecation('symfony/validator', '6.4', 'Class "%s" uses Doctrine Annotations to configure validation constraints, which is deprecated. Use PHP attributes instead.', $reflection->getName());`
	`121`	`+ $this->triggerDeprecationIfAnnotationIsUsed($annotations, sprintf('Class "%s"', $reflection->getName()));`
`122`	`122`	`}`
`123`	`123`	`if ($reflection instanceof \ReflectionMethod && $annotations = $this->reader->getMethodAnnotations($reflection)) {`
`124`		`- trigger_deprecation('symfony/validator', '6.4', 'Method "%s::%s()" uses Doctrine Annotations to configure validation constraints, which is deprecated. Use PHP attributes instead.', $reflection->getDeclaringClass()->getName(), $reflection->getName());`
	`124`	`+ $this->triggerDeprecationIfAnnotationIsUsed($annotations, sprintf('Method "%s::%s()"', $reflection->getDeclaringClass()->getName(), $reflection->getName()));`
`125`	`125`	`}`
`126`	`126`	`if ($reflection instanceof \ReflectionProperty && $annotations = $this->reader->getPropertyAnnotations($reflection)) {`
`127`		`- trigger_deprecation('symfony/validator', '6.4', 'Property "%s::$%s" uses Doctrine Annotations to configure validation constraints, which is deprecated. Use PHP attributes instead.', $reflection->getDeclaringClass()->getName(), $reflection->getName());`
	`127`	`+ $this->triggerDeprecationIfAnnotationIsUsed($annotations, sprintf('Property "%s::$%s"', $reflection->getDeclaringClass()->getName(), $reflection->getName()));`
`128`	`128`	`}`
`129`	`129`
`130`	`130`	`foreach ($dedup as $annotation) {`
`@@ -142,4 +142,18 @@ private function getAnnotations(\ReflectionMethod\|\ReflectionClass\|\ReflectionPr`
`142`	`142`	`}`
`143`	`143`	`}`
`144`	`144`	`}`
	`145`	`+`
	`146`	`+ private function triggerDeprecationIfAnnotationIsUsed(array $annotations, string $messagePrefix): void`
	`147`	`+ {`
	`148`	`+ foreach ($annotations as $annotation) {`
	`149`	`+ if (`
	`150`	`+ $annotation instanceof GroupSequence`
	`151`	`+ \|\| $annotation instanceof GroupSequenceProvider`
	`152`	`+ \|\| $annotation instanceof Constraint`
	`153`	`+ ) {`
	`154`	`+ trigger_deprecation('symfony/validator', '6.4', sprintf('%s uses Doctrine Annotations to configure validation constraints, which is deprecated. Use PHP attributes instead.', $messagePrefix));`
	`155`	`+ break;`
	`156`	`+ }`
	`157`	`+ }`
	`158`	`+ }`
`145`	`159`	`}`