Fix mixed calls diagstics when custom excluder is used (#196)

Author: janedbal

rules.neon

@@ -13,8 +13,6 @@ services:
 
     -
         class: ShipMonk\PHPStan\DeadCode\Debug\DebugUsagePrinter
-        arguments:
-            mixedExcluderEnabled: %shipmonkDeadCode.usageExcluders.usageOverMixed.enabled%
 
     -
         class: ShipMonk\PHPStan\DeadCode\Provider\VendorUsageProvider

src/Debug/DebugUsagePrinter.php

@@ -44,18 +44,14 @@ class DebugUsagePrinter
      */
     private array $debugMembers;
 
-    private bool $mixedExcluderEnabled;
-
     public function __construct(
         Container $container,
         OutputEnhancer $outputEnhancer,
-        ReflectionProvider $reflectionProvider,
-        bool $mixedExcluderEnabled
+        ReflectionProvider $reflectionProvider
     )
     {
         $this->outputEnhancer = $outputEnhancer;
         $this->reflectionProvider = $reflectionProvider;
-        $this->mixedExcluderEnabled = $mixedExcluderEnabled;
         $this->debugMembers = $this->buildDebugMemberKeys(
             // @phpstan-ignore offsetAccess.nonOffsetAccessible, offsetAccess.nonOffsetAccessible, missingType.checkedException, argument.type
             $container->getParameter('shipmonkDeadCode')['debug']['usagesOf'], // prevents https://github.com/phpstan/phpstan/issues/12740
@@ -71,31 +67,34 @@ public function printMixedMemberUsages(Output $output, array $mixedMemberUsages)
             return;
         }
 
-        $fullyMixedUsages = [];
+        $mixedEverythingUsages = [];
+        $mixedClassNameUsages = [];
 
-        foreach ($mixedMemberUsages as $memberType => $collectedUsages) {
-            if (isset($collectedUsages[self::ANY_MEMBER])) {
-                foreach ($collectedUsages[self::ANY_MEMBER] as $collectedUsage) {
-                    $fullyMixedUsages[$memberType][] = $collectedUsage;
-                }
+        foreach ($mixedMemberUsages as $memberType => $collectedUsagesByMemberName) {
+            foreach ($collectedUsagesByMemberName as $memberName => $collectedUsages) {
+                foreach ($collectedUsages as $collectedUsage) {
+                    if ($collectedUsage->isExcluded()) {
+                        continue;
+                    }
 
-                unset($mixedMemberUsages[$memberType][self::ANY_MEMBER]);
+                    if ($memberName === self::ANY_MEMBER) {
+                        $mixedEverythingUsages[$memberType][] = $collectedUsage;
+                    } else {
+                        $mixedClassNameUsages[$memberType][$memberName][] = $collectedUsage;
+                    }
+                }
             }
         }
 
-        $this->printMixedEverythingUsages($output, $fullyMixedUsages);
-        $this->printMixedClassNameUsages($output, $mixedMemberUsages);
+        $this->printMixedEverythingUsages($output, $mixedEverythingUsages);
+        $this->printMixedClassNameUsages($output, $mixedClassNameUsages);
     }
 
     /**
      * @param array<MemberType::*, array<string, non-empty-list<CollectedUsage>>> $mixedMemberUsages
      */
     private function printMixedClassNameUsages(Output $output, array $mixedMemberUsages): void
     {
-        if ($this->mixedExcluderEnabled) {
-            return;
-        }
-
         $totalCount = array_sum(array_map('count', $mixedMemberUsages));
 
         if ($totalCount === 0) {

tests/Rule/DeadCodeRuleTest.php

@@ -93,7 +93,6 @@ protected function getRule(): DeadCodeRule
                     $container,
                     $this->createOutputEnhancer(),
                     self::createReflectionProvider(),
-                    !$this->trackMixedAccess,
                 ),
                 new ClassHierarchy(),
                 !$this->emitErrorsInGroups,
@@ -221,10 +220,10 @@ public function testDiagnoseMixedCalls(): void
         $ec = ''; // hack editorconfig checker to ignore wrong indentation
         $expectedOutput = <<<"OUTPUT"
         <fg=yellow>Found 4 usages over unknown type</>:
-        $ec • <fg=white>getter1</> method, for example in <fg=white>data/methods/mixed/tracked.php:46</>
-        $ec • <fg=white>getter2</> method, for example in <fg=white>data/methods/mixed/tracked.php:49</>
-        $ec • <fg=white>getter3</> method, for example in <fg=white>data/methods/mixed/tracked.php:52</>
-        $ec • <fg=white>staticMethod</> method, for example in <fg=white>data/methods/mixed/tracked.php:57</>
+        $ec • <fg=white>getter1</> method, for example in <fg=white>data/methods/mixed/tracked.php:47</>
+        $ec • <fg=white>getter2</> method, for example in <fg=white>data/methods/mixed/tracked.php:51</>
+        $ec • <fg=white>getter3</> method, for example in <fg=white>data/methods/mixed/tracked.php:54</>
+        $ec • <fg=white>staticMethod</> method, for example in <fg=white>data/methods/mixed/tracked.php:59</>
 
         Thus, any member named the same is considered used, no matter its declaring class!
 
@@ -856,7 +855,7 @@ private function getMemberUsageExcluders(): array
 
                 public function getIdentifier(): string
                 {
-                    return 'mixed';
+                    return 'mixedPrefix';
                 }
 
                 public function shouldExclude(ClassMemberUsage $usage, Node $node, Scope $scope): bool

tests/Rule/data/debug/exclude.php

@@ -4,8 +4,8 @@
 
 class Foo
 {
-    public static function mixedExcluder1() {} // error: Unused DebugExclude\Foo::mixedExcluder1 (all usages excluded by mixed excluder)
-    public static function mixedExcluder2() {} // error: Unused DebugExclude\Foo::mixedExcluder2 (all usages excluded by mixed excluder)
+    public static function mixedExcluder1() {} // error: Unused DebugExclude\Foo::mixedExcluder1 (all usages excluded by mixedPrefix excluder)
+    public static function mixedExcluder2() {} // error: Unused DebugExclude\Foo::mixedExcluder2 (all usages excluded by mixedPrefix excluder)
 }
 
 class Chld extends Foo {

tests/Rule/data/debug/expected_output.txt

@@ -39,7 +39,7 @@ DebugExclude\Foo::mixedExcluder1
 | all usages are excluded
 |
 | Found 1 usage:
-|  • data/debug/exclude.php:15 - excluded by mixed excluder
+|  • data/debug/exclude.php:15 - excluded by mixedPrefix excluder
 
 
 DebugExclude\Foo::mixedExcluder2
@@ -48,7 +48,7 @@ DebugExclude\Foo::mixedExcluder2
 | all usages are excluded
 |
 | Found 1 usage:
-|  • data/debug/exclude.php:16 - excluded by mixed excluder
+|  • data/debug/exclude.php:16 - excluded by mixedPrefix excluder
 
 
 DebugNever\Foo::__get

tests/Rule/data/excluders/mixed/code.php

@@ -3,11 +3,11 @@
 namespace MixedExcluder;
 
 class SomeParent {
-    public function mixed1() {} // error: Unused MixedExcluder\SomeParent::mixed1 (all usages excluded by mixed excluder)
+    public function mixed1() {} // error: Unused MixedExcluder\SomeParent::mixed1 (all usages excluded by mixedPrefix excluder)
 }
 
 class Some extends SomeParent {
-    public function mixed2() {} // error: Unused MixedExcluder\Some::mixed2 (all usages excluded by mixed excluder)
+    public function mixed2() {} // error: Unused MixedExcluder\Some::mixed2 (all usages excluded by mixedPrefix excluder)
 }
 
 function test(Some $some) {

tests/Rule/data/methods/mixed/tracked.php

@@ -36,6 +36,7 @@ public function getter3() {}
     public function getter4() {}
     public function getter5() {} // error: Unused DeadMixed1\Implementor::getter5
     public function getter6() {}
+    public function mixedGetter7() {} // error: Unused DeadMixed1\Implementor::mixedGetter7 (all usages excluded by mixedPrefix excluder)
 
 }
 
@@ -44,6 +45,7 @@ class Tester
     function __construct($mixed, string $notClass, object $object, IFace $iface, int|Clazz $maybeClass)
     {
         $mixed->getter1(); // may be valid call
+        $mixed->mixedGetter7(); // excluded call
 
         if (!$mixed instanceof Clazz) {
             $mixed->getter2(); // ideally, should mark only IFace, not Clazz (not implemented)