test(phpstan): Update and simplify PHPStan config options (#1404)

Author: klausi

.github/workflows/testing.yml

@@ -101,7 +101,7 @@ jobs:
         # Pin the exact Coder version to upgrade manually when we want to.
         run: |
           composer --no-interaction --no-progress require \
-            phpstan/phpstan:^1.10.38 \
+            phpstan/phpstan:^1.11.2 \
             mglaman/phpstan-drupal:^1.1.2 \
             phpstan/phpstan-deprecation-rules:^1.0.0 \
             jangregor/phpstan-prophecy:^1.0.0 \

phpstan.neon

@@ -1,29 +1,14 @@
 parameters:
-  # PHPStan cannot find files in this test directory automatically.
-  scanDirectories:
-    - ../../core/tests/Drupal/Tests
   level: 6
   customRulesetUsed: true
   paths:
     - .
-  # We inherit a lot of Drupal core docs that don't specify iterable types on
-  # arrays, not sure we can fix this in a good way.
-  checkMissingIterableValueType: false
-  # Not sure we can specify generic types properly with Drupal coding standards
-  # yet, disable for now.
-  checkGenericClassInNonGenericObjectType: false
-  excludePaths:
-    # Exclude the RouteLoad producer because the redirect module is not D10
-    # compatible so we are not downloading it.
-    - src/Plugin/GraphQL/DataProducer/Routing/RouteLoad.php
   ignoreErrors:
-    # @todo Ignore phpstan-drupal extension's rules for now, activate later.
-    - '#\Drupal calls should be avoided in classes, use dependency injection instead#'
+    # We inherit a lot of Drupal core docs that don't specify iterable types on
+    # arrays, not sure we can fix this in a good way.
+    - identifier: missingType.iterableValue
     # new static() is a best practice in Drupal, so we cannot fix that.
     - "#^Unsafe usage of new static\\(\\)\\.$#"
-    # Drupal allows object property access to custom fields, so we cannot fix
-    # that.
-    - "#^Access to an undefined property Drupal\\\\#"
     # We forgot to use return type hints on some interfaces, cannot be changed
     # in stable 4.0.
     # @todo use return type hints everywhere for 5.0.
@@ -51,3 +36,34 @@ parameters:
       message: "#^Method Drupal\\\\graphql\\\\Entity\\\\ServerInterface\\:\\:removePersistedQueryInstance\\(\\) has no return type specified\\.$#"
       count: 1
       path: src/Entity/ServerInterface.php
+
+    # @todo Some leftover \Drupal calls that can be fixed later.
+    -
+      message: "#^\\\\Drupal calls should be avoided in classes, use dependency injection instead$#"
+      count: 1
+      path: examples/graphql_example/src/Wrappers/QueryConnection.php
+
+    -
+      message: "#^\\\\Drupal calls should be avoided in classes, use dependency injection instead$#"
+      count: 3
+      path: src/Controller/ServerListBuilder.php
+
+    -
+      message: "#^\\\\Drupal calls should be avoided in classes, use dependency injection instead$#"
+      count: 1
+      path: src/GraphQL/Execution/Executor.php
+
+    -
+      message: "#^\\\\Drupal calls should be avoided in classes, use dependency injection instead$#"
+      count: 1
+      path: src/Plugin/GraphQL/DataProducer/Entity/Fields/Image/ImageDerivative.php
+
+    -
+      message: "#^\\\\Drupal calls should be avoided in classes, use dependency injection instead$#"
+      count: 1
+      path: src/Plugin/GraphQL/DataProducer/EntityDefinition/EntityDefinition.php
+
+    -
+      message: "#^\\\\Drupal calls should be avoided in classes, use dependency injection instead$#"
+      count: 1
+      path: src/Plugin/GraphQL/DataProducer/User/PasswordReset.php

src/GraphQL/Buffers/BufferBase.php

@@ -10,14 +10,14 @@ abstract class BufferBase {
   /**
    * The the array of buffers.
    *
-   * @var \SplObjectStorage[]
+   * @var \SplObjectStorage<object, object>[]
    */
   protected $buffers = [];
 
   /**
    * The array of result sets.
    *
-   * @var \SplObjectStorage[]
+   * @var \SplObjectStorage<object, object>[]
    */
   protected $results = [];
 
@@ -65,9 +65,9 @@ public function createBufferResolver($item) {
    *
    * @param object $item
    *   The item to add to create the resolver for.
-   * @param \SplObjectStorage $buffer
+   * @param \SplObjectStorage<object, object> $buffer
    *   The buffer.
-   * @param \SplObjectStorage $result
+   * @param \SplObjectStorage<object, object> $result
    *   The result set.
    *
    * @return \Closure
@@ -85,9 +85,9 @@ protected function createResolver($item, \SplObjectStorage $buffer, \SplObjectSt
    *
    * @param object $item
    *   The buffer item to retrieve the result for.
-   * @param \SplObjectStorage $buffer
+   * @param \SplObjectStorage<object, object> $buffer
    *   The buffer.
-   * @param \SplObjectStorage $result
+   * @param \SplObjectStorage<object, object> $result
    *   The result set.
    *
    * @return mixed
@@ -112,10 +112,10 @@ protected function resolveItem($item, \SplObjectStorage $buffer, \SplObjectStora
   /**
    * Resolves the given buffer wholly.
    *
-   * @param \SplObjectStorage $buffer
+   * @param \SplObjectStorage<object, object> $buffer
    *   The buffer to be resolved wholly.
    *
-   * @return \SplObjectStorage
+   * @return \SplObjectStorage<object, object>
    *   The resolved results for the given buffer, keyed by the corresponding
    *   buffer items.
    */

src/Plugin/GraphQL/DataProducer/Entity/Fields/Image/ImageDerivative.php

@@ -98,7 +98,9 @@ public function resolve(FileInterface $entity = NULL, $style, RefinableCacheable
     $metadata->addCacheableDependency($access);
     if ($access->isAllowed() && $image_style = ImageStyle::load($style)) {
 
+      // @phpstan-ignore-next-line
       $width = $entity->width;
+      // @phpstan-ignore-next-line
       $height = $entity->height;
 
       if (empty($width) || empty($height)) {

tests/src/Traits/MockingTrait.php

@@ -106,7 +106,7 @@ protected function setUpSchema($schema, $id = 'test', array $values = []): void
   protected function createTestServer($schema, $endpoint, array $values = []): void {
     $this->server = Server::create([
       'schema' => $schema,
-      'name' => $this->randomGenerator->name(),
+      'name' => $this->randomMachineName(),
       'endpoint' => $endpoint,
     ] + $values);