Merge branch 'main' into fix-entity-query-type-cache

Author: mglaman

.github/workflows/phpstan-dev.yml

@@ -13,9 +13,7 @@ jobs:
     strategy:
       matrix:
         phpstan:
-          - '1.8.x-dev'
-          - '1.7.x-dev'
-          - '1.6.x-dev'
+          - '1.9.x-dev'
     steps:
       - name: "Checkout"
         uses: "actions/checkout@v2"

composer.json

@@ -12,7 +12,7 @@
     "require": {
         "php": "^7.4 || ^8.0",
         "symfony/finder": "~3.4.5 ||^4.2 || ^5.0 || ^6.0",
-        "phpstan/phpstan": "^1.6.0",
+        "phpstan/phpstan": "^1.9.0",
         "symfony/yaml": "~3.4.5 || ^4.2|| ^5.0 || ^6.0",
         "webflo/drupal-finder": "^1.2"
     },

src/Drupal/ExtensionDiscovery.php

@@ -376,7 +376,7 @@ protected function scanDirectory($dir): array
             // Determine extension type from info file.
             $type = false;
             $file = $fileinfo->openFile('r');
-            while (!$type && !$file->eof()) {
+            while ($type === false && !$file->eof()) {
                 if ($line = $file->fgets()) {
                     preg_match('@^type:\s*(\'|")?(\w+)\1?\s*$@', $line, $matches);
                     if (isset($matches[2])) {

src/Rules/Drupal/GlobalDrupalDependencyInjectionRule.php

@@ -28,9 +28,6 @@ public function processNode(Node $node, Scope $scope): array
             return [];
         }
         $scopeClassReflection = $scope->getClassReflection();
-        if ($scopeClassReflection === null) {
-            throw new ShouldNotHappenException();
-        }
 
         $allowed_list = [
             // Ignore tests.

src/Rules/Drupal/PluginManager/PluginManagerSetsCacheBackendRule.php

@@ -38,10 +38,6 @@ public function processNode(Node $node, Scope $scope): array
 
         $scopeClassReflection = $scope->getClassReflection();
 
-        if ($scopeClassReflection === null) {
-            throw new ShouldNotHappenException();
-        }
-
         if (!$this->isPluginManager($scopeClassReflection)) {
             return [];
         }

src/Rules/Drupal/RenderCallbackRule.php

@@ -68,8 +68,6 @@ public function processNode(Node $node, Scope $scope): array
         if ($keyChecked === '#lazy_builder') {
             if ($scope->isInClass()) {
                 $classReflection = $scope->getClassReflection();
-                // @todo why doesn't isInClass assert this isn't null?
-                assert($classReflection !== null);
                 $classType = new ObjectType($classReflection->getName());
                 // These classes use #lazy_builder in array_intersect_key. With
                 // PHPStan 1.6, nodes do not track their parent/next/prev which
@@ -162,22 +160,21 @@ private function doProcessNode(Node\Expr $node, Scope $scope, string $keyChecked
                     sprintf("%s callback %s at key '%s' is not callable.", $keyChecked, $type->describe(VerbosityLevel::value()), $pos)
                 )->line($errorLine)->build();
             }
-            $typeAndMethodName = $type->findTypeAndMethodName();
-            if ($typeAndMethodName === null) {
+            $typeAndMethodNames = $type->findTypeAndMethodNames();
+            if ($typeAndMethodNames === []) {
                 throw new \PHPStan\ShouldNotHappenException();
             }
 
-            if (!$trustedCallbackType->isSuperTypeOf($typeAndMethodName->getType())->yes()) {
-                return RuleErrorBuilder::message(
-                    sprintf("%s callback class '%s' at key '%s' does not implement Drupal\Core\Security\TrustedCallbackInterface.", $keyChecked, $typeAndMethodName->getType()->describe(VerbosityLevel::value()), $pos)
-                )->line($errorLine)->tip('Change record: https://www.drupal.org/node/2966725.')->build();
+            foreach ($typeAndMethodNames as $typeAndMethodName) {
+                if (!$trustedCallbackType->isSuperTypeOf($typeAndMethodName->getType())->yes()) {
+                    return RuleErrorBuilder::message(
+                        sprintf("%s callback class '%s' at key '%s' does not implement Drupal\Core\Security\TrustedCallbackInterface.", $keyChecked, $typeAndMethodName->getType()->describe(VerbosityLevel::value()), $pos)
+                    )->line($errorLine)->tip('Change record: https://www.drupal.org/node/2966725.')->build();
+                }
             }
         } elseif ($type instanceof ClosureType) {
             if ($scope->isInClass()) {
                 $classReflection = $scope->getClassReflection();
-                if ($classReflection === null) {
-                    throw new \PHPStan\ShouldNotHappenException();
-                }
                 $classType = new ObjectType($classReflection->getName());
                 $formType = new ObjectType('\Drupal\Core\Form\FormInterface');
                 if ($formType->isSuperTypeOf($classType)->yes()) {
@@ -224,7 +221,7 @@ private function getType(Node\Expr $node, Scope $scope):  Type
                 }
             }
         } elseif ($type instanceof ConstantStringType) {
-            if ($type->isClassString()) {
+            if ($type->isClassStringType()->yes()) {
                 return $type;
             }
             // Covers  \Drupal\Core\Controller\ControllerResolver::createController.
@@ -245,7 +242,7 @@ private function getType(Node\Expr $node, Scope $scope):  Type
             }
             // @see \PHPStan\Type\Constant\ConstantStringType::isCallable
             preg_match('#^([a-zA-Z_\\x7f-\\xff\\\\][a-zA-Z0-9_\\x7f-\\xff\\\\]*)::([a-zA-Z_\\x7f-\\xff][a-zA-Z0-9_\\x7f-\\xff]*)\\z#', $type->getValue(), $matches);
-            if ($matches !== null && count($matches) > 0) {
+            if (count($matches) > 0) {
                 return new ConstantArrayType(
                     [new ConstantIntegerType(0), new ConstantIntegerType(1)],
                     [

stubs/Drupal/Core/Field/EntityReferenceFieldItemListInterface.stub

@@ -13,4 +13,9 @@ use Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem;
  */
 interface EntityReferenceFieldItemListInterface extends FieldItemListInterface {
 
+  /**
+   * @return array<int, T>
+   */
+  public function referencedEntities();
+
 }

tests/fixtures/drupal/modules/phpstan_fixtures/src/Entity/ReflectionEntityTest.php

@@ -9,6 +9,7 @@
 
 /**
  * @property \Drupal\Core\Field\EntityReferenceFieldItemListInterface $user_id
+ * @property \Drupal\Core\Field\EntityReferenceFieldItemListInterface<\Drupal\entity_test\Entity\EntityTest> $related
  */
 final class ReflectionEntityTest extends ContentEntityBase {
 
@@ -34,6 +35,14 @@ public static function baseFieldDefinitions(EntityTypeInterface $entity_type)
                     'placeholder' => '',
                 ],
             ]);
+
+        $fields['related'] = BaseFieldDefinition::create('entity_reference')
+            ->setLabel(t('Related entities'))
+            ->setDescription(t('The IDs of the related entities.'))
+            ->setSetting('target_type', 'entity_test')
+            ->setSetting('handler', 'default')
+            ->setTranslatable(TRUE)
+            ->setDisplayConfigurable('form', FALSE);
         return $fields;
     }
 

tests/src/Type/data/entity-properties.php

@@ -11,3 +11,6 @@
 
 $entity = ReflectionEntityTest::create();
 assertType('Drupal\Core\Field\EntityReferenceFieldItemListInterface', $entity->user_id);
+assertType('Drupal\Core\Field\EntityReferenceFieldItemListInterface<Drupal\entity_test\Entity\EntityTest>', $entity->related);
+// Value of array is derived from 'related' generic.
+assertType('array<int, Drupal\entity_test\Entity\EntityTest>', $entity->related->referencedEntities());