[ErrorHandler] Report overridden @Final constants

Author: fancyweb

CHANGELOG.md

@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+6.1
+---
+
+ * Report overridden `@final` constants
+
 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 $finalConstants = [];
     private static array $deprecated = [];
     private static array $internal = [];
     private static array $internalMethods = [];
@@ -468,8 +469,9 @@ public function checkAnnotations(\ReflectionClass $refl, string $class): array
         self::$finalMethods[$class] = [];
         self::$internalMethods[$class] = [];
         self::$annotatedParameters[$class] = [];
+        self::$finalConstants[$class] = [];
         foreach ($parentAndOwnInterfaces as $use) {
-            foreach (['finalMethods', 'internalMethods', 'annotatedParameters', 'returnTypes'] as $property) {
+            foreach (['finalMethods', 'internalMethods', 'annotatedParameters', 'returnTypes', 'finalConstants'] as $property) {
                 if (isset(self::${$property}[$use])) {
                     self::${$property}[$class] = self::${$property}[$class] ? self::${$property}[$use] + self::${$property}[$class] : self::${$property}[$use];
                 }
@@ -624,6 +626,24 @@ public function checkAnnotations(\ReflectionClass $refl, string $class): array
             }
         }
 
+        foreach ($refl->getReflectionConstants(\ReflectionClassConstant::IS_PUBLIC | \ReflectionClassConstant::IS_PROTECTED) as $constant) {
+            if ($constant->class !== $class) {
+                continue;
+            }
+
+            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);
+                }
+            }
+
+            if (!($doc = $this->parsePhpDoc($constant)) || !isset($doc['final'])) {
+                continue;
+            }
+
+            self::$finalConstants[$class][$constant->name] = $class;
+        }
+
         return $deprecations;
     }
 

Tests/DebugClassLoaderTest.php

@@ -400,6 +400,43 @@ class_exists('Test\\'.ReturnType::class, true);
             'Method "Symfony\Component\ErrorHandler\Tests\Fixtures\ReturnTypeParent::static()" might add "static" as a native return type declaration in the future. Do the same in child class "Test\Symfony\Component\ErrorHandler\Tests\ReturnType" now to avoid errors or add an explicit @return annotation to suppress this message.',
         ], $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);
+
+        error_reporting($e);
+        restore_error_handler();
+
+        $this->assertSame([
+            'The "Symfony\Component\ErrorHandler\Tests\Fixtures\FinalConstant\FinalConstants::OVERRIDDEN_FINAL_PARENT_CLASS" constant is considered final. You should not override it in "Symfony\Component\ErrorHandler\Tests\Fixtures\FinalConstant\OverrideFinalConstant".',
+            'The "Symfony\Component\ErrorHandler\Tests\Fixtures\FinalConstant\FinalConstants2::OVERRIDDEN_FINAL_PARENT_PARENT_CLASS" constant is considered final. You should not override it in "Symfony\Component\ErrorHandler\Tests\Fixtures\FinalConstant\OverrideFinalConstant".',
+        ], $deprecations);
+    }
+
+    /**
+     * @requires PHP 8.1
+     */
+    public function testOverrideFinalConstant81()
+    {
+        $deprecations = [];
+        set_error_handler(function ($type, $msg) use (&$deprecations) { $deprecations[] = $msg; });
+        $e = error_reporting(E_USER_DEPRECATED);
+
+        class_exists( Fixtures\FinalConstant\OverrideFinalConstant81::class, true);
+
+        error_reporting($e);
+        restore_error_handler();
+
+        $this->assertSame([
+            'The "Symfony\Component\ErrorHandler\Tests\Fixtures\FinalConstant\FinalConstantsInterface::OVERRIDDEN_FINAL_INTERFACE" constant is considered final. You should not override it in "Symfony\Component\ErrorHandler\Tests\Fixtures\FinalConstant\OverrideFinalConstant81".',
+            'The "Symfony\Component\ErrorHandler\Tests\Fixtures\FinalConstant\FinalConstantsInterface2::OVERRIDDEN_FINAL_INTERFACE_2" constant is considered final. You should not override it in "Symfony\Component\ErrorHandler\Tests\Fixtures\FinalConstant\OverrideFinalConstant81".',
+        ], $deprecations);
+    }
 }
 
 class ClassLoader

Tests/Fixtures/FinalConstant/FinalConstants.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Symfony\Component\ErrorHandler\Tests\Fixtures\FinalConstant;
+
+class FinalConstants extends FinalConstants2
+{
+    /**
+     * @final
+     */
+    protected const OVERRIDDEN_FINAL_PARENT_CLASS = 'OVERRIDDEN_FINAL_PARENT_CLASS';
+
+    protected const OVERRIDDEN_NOT_FINAL_PARENT_CLASS = 'OVERRIDDEN_NOT_FINAL_PARENT_CLASS';
+
+    /**
+     * @final
+     */
+    public const NOT_OVERRIDDEN_FINAL_PARENT_CLASS = 'NOT_OVERRIDDEN_FINAL_PARENT_CLASS';
+
+    public const NOT_OVERRIDDEN_NOT_FINAL_PARENT_CLASS = 'NOT_OVERRIDDEN_NOT_FINAL_PARENT_CLASS';
+
+    private const FOO = 'FOO';
+}

Tests/Fixtures/FinalConstant/FinalConstants2.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Symfony\Component\ErrorHandler\Tests\Fixtures\FinalConstant;
+
+class FinalConstants2 {
+    /**
+     * @final
+     */
+    public const OVERRIDDEN_FINAL_PARENT_PARENT_CLASS = 'OVERRIDDEN_FINAL_PARENT_PARENT_CLASS';
+
+    public const OVERRIDDEN_NOT_FINAL_PARENT_PARENT_CLASS = 'OVERRIDDEN_NOT_FINAL_PARENT_PARENT_CLASS';
+
+    /**
+     * @final
+     */
+    public const NOT_OVERRIDDEN_FINAL_PARENT_PARENT_CLASS = 'NOT_OVERRIDDEN_FINAL_PARENT_PARENT_CLASS';
+
+    public const NOT_OVERRIDDEN_NOT_FINAL_PARENT_PARENT_CLASS = 'NOT_OVERRIDDEN_NOT_FINAL_PARENT_PARENT_CLASS';
+}

Tests/Fixtures/FinalConstant/FinalConstantsInterface.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Symfony\Component\ErrorHandler\Tests\Fixtures\FinalConstant;
+
+interface FinalConstantsInterface
+{
+    /**
+     * @final
+     */
+    public const OVERRIDDEN_FINAL_INTERFACE = 'OVERRIDDEN_FINAL_INTERFACE';
+
+    public const OVERRIDDEN_NOT_FINAL_INTERFACE = 'OVERRIDDEN_NOT_FINAL_INTERFACE';
+
+    /**
+     * @final
+     */
+    public const NOT_OVERRIDDEN_FINAL_INTERFACE = 'NOT_OVERRIDDEN_FINAL_INTERFACE';
+
+    public const NOT_OVERRIDDEN_NOT_FINAL_INTERFACE = 'NOT_OVERRIDDEN_NOT_FINAL_INTERFACE';
+}

Tests/Fixtures/FinalConstant/FinalConstantsInterface2.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Symfony\Component\ErrorHandler\Tests\Fixtures\FinalConstant;
+
+interface FinalConstantsInterface2 extends FinalConstantsInterface
+{
+    /**
+     * @final for whatever reason
+     */
+    public const OVERRIDDEN_FINAL_INTERFACE_2 = 'OVERRIDDEN_FINAL_INTERFACE_2';
+
+    public const OVERRIDDEN_NOT_FINAL_INTERFACE_2 = 'OVERRIDDEN_NOT_FINAL_INTERFACE_2';
+
+    /**
+     * @final
+     */
+    public const NOT_OVERRIDDEN_FINAL_INTERFACE_2 = 'NOT_OVERRIDDEN_FINAL_INTERFACE_2';
+
+    public const NOT_OVERRIDDEN_NOT_FINAL_INTERFACE_2 = 'NOT_OVERRIDDEN_NOT_FINAL_INTERFACE_2';
+}

Tests/Fixtures/FinalConstant/OverrideFinalConstant.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Symfony\Component\ErrorHandler\Tests\Fixtures\FinalConstant;
+
+class OverrideFinalConstant extends FinalConstants
+{
+    public const FOO = 'FOO';
+
+    protected const OVERRIDDEN_FINAL_PARENT_CLASS = 'O_OVERRIDDEN_FINAL_PARENT_CLASS';
+
+    protected const OVERRIDDEN_NOT_FINAL_PARENT_CLASS = 'O_OVERRIDDEN_NOT_FINAL_PARENT_CLASS';
+
+    public const OVERRIDDEN_FINAL_PARENT_PARENT_CLASS = 'O_OVERRIDDEN_FINAL_PARENT_PARENT_CLASS';
+
+    public const OVERRIDDEN_NOT_FINAL_PARENT_PARENT_CLASS = 'O_OVERRIDDEN_NOT_FINAL_PARENT_PARENT_CLASS';
+
+    private const CCC = 'CCC';
+}

Tests/Fixtures/FinalConstant/OverrideFinalConstant81.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Symfony\Component\ErrorHandler\Tests\Fixtures\FinalConstant;
+
+class OverrideFinalConstant81 implements FinalConstantsInterface2
+{
+    public const FOO = 'FOO';
+
+    public const OVERRIDDEN_FINAL_INTERFACE = 'O_OVERRIDDEN_FINAL_INTERFACE';
+
+    public const OVERRIDDEN_NOT_FINAL_INTERFACE = 'O_OVERRIDDEN_NOT_FINAL_INTERFACE';
+
+    public const OVERRIDDEN_FINAL_INTERFACE_2 = 'O_OVERRIDDEN_FINAL_INTERFACE_2';
+
+    public const OVERRIDDEN_NOT_FINAL_INTERFACE_2 = 'O_OVERRIDDEN_NOT_FINAL_INTERFACE_2';
+
+    private const CCC = 'CCC';
+}