2.x: Fix assertAll causes staticMethod.alreadyNarrowedType (#858)

* Add alreadyNarrowedType test for bug 857

* WIP

* WIP

* Update src/Type/InspectorTypeExtension.php

Co-authored-by: Matt Glaman <[email protected]>

* Update test cases with updated 'Inspector'

---------

Co-authored-by: Matt Glaman <[email protected]>

Author: Niklan

src/Type/InspectorTypeExtension.php

@@ -107,6 +107,16 @@ private function specifyAssertAll(MethodReflection $staticMethodReflection, Stat
             return new SpecifiedTypes();
         }
 
+        $traversable = $node->getArgs()[1]->value;
+        $traversableInfo = $scope->getType($traversable);
+
+        // If it is already not mixed (narrowed by other code, like
+        // '::assertAllArray()'), we could not provide any additional
+        // information. We can only narrow this method to 'array<mixed, mixed>'.
+        if (!$traversableInfo->equals(new MixedType())) {
+            return new SpecifiedTypes();
+        }
+
         // In a negation context, we cannot precisely narrow types because we do
         // not know the exact logic of the callable function. This means we
         // cannot safely return 'mixed~iterable' since the value might still be

tests/src/Rules/ImpossibleCheckTypeStaticMethodCallRuleTest.php

@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+namespace mglaman\PHPStanDrupal\Tests\Rules;
+
+use mglaman\PHPStanDrupal\Rules\Drupal\Tests\TestClassSuffixNameRule;
+use mglaman\PHPStanDrupal\Tests\DrupalRuleTestCase;
+use PHPStan\Rules\Comparison\ImpossibleCheckTypeHelper;
+use PHPStan\Rules\Comparison\ImpossibleCheckTypeStaticMethodCallRule;
+use PHPStan\Rules\Rule;
+
+class ImpossibleCheckTypeStaticMethodCallRuleTest extends DrupalRuleTestCase
+{
+
+    private bool $treatPhpDocTypesAsCertain = false;
+
+    private bool $reportAlwaysTrueInLastCondition = false;
+
+    protected function getRule(): Rule
+    {
+        /** @phpstan-ignore phpstanApi.constructor */
+        return new ImpossibleCheckTypeStaticMethodCallRule(
+            /** @phpstan-ignore phpstanApi.constructor */
+            new ImpossibleCheckTypeHelper(
+                $this->createReflectionProvider(),
+                $this->getTypeSpecifier(),
+                [],
+                $this->treatPhpDocTypesAsCertain,
+            ),
+            $this->treatPhpDocTypesAsCertain,
+            $this->reportAlwaysTrueInLastCondition,
+            true,
+        );
+    }
+
+    protected function shouldTreatPhpDocTypesAsCertain(): bool
+    {
+        return $this->treatPhpDocTypesAsCertain;
+    }
+
+
+    public function testBug857(): void
+    {
+        $this->treatPhpDocTypesAsCertain = true;
+        // It shouldn't report anything.
+        $this->analyse([__DIR__ . '/data/bug-857.php'], []);
+    }
+
+}

tests/src/Rules/data/bug-857.php

@@ -0,0 +1,11 @@
+<?php
+
+use Drupal\Component\Assertion\Inspector;
+use Drupal\Core\Url;
+
+function foo(array $images) {
+    // This call is crucial for the bug, because it narrows type to
+    // 'array<array>'.
+    Inspector::assertAllArrays($images);
+    Inspector::assertAll(fn (array $i): bool => $i['file'] instanceof Url, $images);
+}

tests/src/Type/InspectorTypeExtensionTest.php

@@ -14,6 +14,7 @@ final class InspectorTypeExtensionTest extends TypeInferenceTestCase {
   public static function dataFileAsserts(): iterable {
     yield from self::gatherAssertTypes(__DIR__ . '/data/inspector.php');
     yield from self::gatherAssertTypes(__DIR__ . '/data/bug-852.php');
+    yield from self::gatherAssertTypes(__DIR__ . '/data/bug-857.php');
   }
 
   /**

tests/src/Type/data/bug-857.php

@@ -0,0 +1,21 @@
+<?php
+
+use Drupal\Component\Assertion\Inspector;
+use function PHPStan\Testing\assertType;
+
+function mixed_function(): mixed {}
+
+// If the type is not narrowed from 'mixed' before call, it is narrowed to
+// 'iterable'.
+$array = mixed_function();
+assertType('mixed', $array);
+\assert(Inspector::assertAll(fn (array $i): bool => TRUE, $array));
+assertType('iterable', $array);
+
+// If the type is narrowed before '::assertAll()', it shouldn't change it.
+$array = mixed_function();
+assertType('mixed', $array);
+\assert(Inspector::assertAllArrays($array));
+assertType('iterable<array>', $array);
+\assert(Inspector::assertAll(fn (array $i): bool => TRUE, $array));
+assertType('iterable<array>', $array);