[ErrorHandler] trigger deprecations for @final properties

Author: nicolas-grekas

CHANGELOG.md

@@ -4,7 +4,7 @@ CHANGELOG
 6.1
 ---
 
- * Report overridden `@final` constants
+ * Report overridden `@final` constants and properties
 
 5.4
 ---

DebugClassLoader.php

@@ -112,6 +112,7 @@ class DebugClassLoader
     private static array $checkedClasses = [];
     private static array $final = [];
     private static array $finalMethods = [];
+    private static array $finalProperties = [];
     private static array $finalConstants = [];
     private static array $deprecated = [];
     private static array $internal = [];
@@ -469,9 +470,10 @@ public function checkAnnotations(\ReflectionClass $refl, string $class): array
         self::$finalMethods[$class] = [];
         self::$internalMethods[$class] = [];
         self::$annotatedParameters[$class] = [];
+        self::$finalProperties[$class] = [];
         self::$finalConstants[$class] = [];
         foreach ($parentAndOwnInterfaces as $use) {
-            foreach (['finalMethods', 'internalMethods', 'annotatedParameters', 'returnTypes', 'finalConstants'] as $property) {
+            foreach (['finalMethods', 'internalMethods', 'annotatedParameters', 'returnTypes', 'finalProperties', 'finalConstants'] as $property) {
                 if (isset(self::${$property}[$use])) {
                     self::${$property}[$class] = self::${$property}[$class] ? self::${$property}[$use] + self::${$property}[$class] : self::${$property}[$use];
                 }
@@ -626,22 +628,29 @@ public function checkAnnotations(\ReflectionClass $refl, string $class): array
             }
         }
 
-        foreach ($refl->getReflectionConstants(\ReflectionClassConstant::IS_PUBLIC | \ReflectionClassConstant::IS_PROTECTED) as $constant) {
-            if ($constant->class !== $class) {
-                continue;
-            }
+        $finals = isset(self::$final[$class]) || $refl->isFinal() ? [] : [
+            'finalConstants' => $refl->getReflectionConstants(\ReflectionClassConstant::IS_PUBLIC | \ReflectionClassConstant::IS_PROTECTED),
+            'finalProperties' => $refl->getProperties(\ReflectionProperty::IS_PUBLIC | \ReflectionProperty::IS_PROTECTED),
+        ];
+        foreach ($finals as $type => $reflectors) {
+            foreach ($reflectors as $r) {
+                if ($r->class !== $class) {
+                    continue;
+                }
+
+                $doc = $this->parsePhpDoc($r);
 
-            foreach ($parentAndOwnInterfaces as $use) {
-                if (isset(self::$finalConstants[$use][$constant->name])) {
-                    $deprecations[] = sprintf('The "%s::%s" constant is considered final. You should not override it in "%s".', self::$finalConstants[$use][$constant->name], $constant->name, $class);
+                foreach ($parentAndOwnInterfaces as $use) {
+                    if (isset(self::${$type}[$use][$r->name]) && !isset($doc['deprecated']) && ('finalConstants' === $type || substr($use, 0, strrpos($use, '\\')) !== substr($use, 0, strrpos($class, '\\')))) {
+                        $msg = 'finalConstants' === $type ? '%s" constant' : '$%s" property';
+                        $deprecations[] = sprintf('The "%s::'.$msg.' is considered final. You should not override it in "%s".', self::${$type}[$use][$r->name], $r->name, $class);
+                    }
                 }
-            }
 
-            if (!($doc = $this->parsePhpDoc($constant)) || !isset($doc['final'])) {
-                continue;
+                if (isset($doc['final']) || ('finalProperties' === $type && str_starts_with($class, 'Symfony\\') && !$r->hasType())) {
+                    self::${$type}[$class][$r->name] = $class;
+                }
             }
-
-            self::$finalConstants[$class][$constant->name] = $class;
         }
 
         return $deprecations;

Tests/DebugClassLoaderTest.php

@@ -401,13 +401,30 @@ class_exists('Test\\'.ReturnType::class, true);
         ], $deprecations);
     }
 
+    public function testOverrideFinalProperty()
+    {
+        $deprecations = [];
+        set_error_handler(function ($type, $msg) use (&$deprecations) { $deprecations[] = $msg; });
+        $e = error_reporting(E_USER_DEPRECATED);
+
+        class_exists(Fixtures\OverrideFinalProperty::class, true);
+
+        error_reporting($e);
+        restore_error_handler();
+
+        $this->assertSame([
+            'The "Symfony\Component\ErrorHandler\Tests\Fixtures\FinalProperty\FinalProperty::$pub" property is considered final. You should not override it in "Symfony\Component\ErrorHandler\Tests\Fixtures\OverrideFinalProperty".',
+            'The "Symfony\Component\ErrorHandler\Tests\Fixtures\FinalProperty\FinalProperty::$prot" property is considered final. You should not override it in "Symfony\Component\ErrorHandler\Tests\Fixtures\OverrideFinalProperty".',
+        ], $deprecations);
+    }
+
     public function testOverrideFinalConstant()
     {
         $deprecations = [];
         set_error_handler(function ($type, $msg) use (&$deprecations) { $deprecations[] = $msg; });
         $e = error_reporting(E_USER_DEPRECATED);
 
-        class_exists( Fixtures\FinalConstant\OverrideFinalConstant::class, true);
+        class_exists(Fixtures\FinalConstant\OverrideFinalConstant::class, true);
 
         error_reporting($e);
         restore_error_handler();

Tests/Fixtures/FinalProperty/FinalProperty.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Symfony\Component\ErrorHandler\Tests\Fixtures\FinalProperty;
+
+class FinalProperty
+{
+    /**
+     * @final
+     */
+    public $pub;
+
+    /**
+     * @final
+     */
+    protected $prot;
+
+    /**
+     * @final
+     */
+    private $priv;
+}

Tests/Fixtures/OverrideFinalProperty.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace Symfony\Component\ErrorHandler\Tests\Fixtures;
+
+use Symfony\Component\ErrorHandler\Tests\Fixtures\FinalProperty\FinalProperty;
+
+class OverrideFinalProperty extends FinalProperty
+{
+    public $pub;
+    protected $prot;
+    private $priv;
+}